Flip Energy API
  • Overview
  • Important concepts
  • Authentication
  • Enrollment process
  • End-user app design
  • Monitoring / Telemetry
  • Control
  • Mobile App API
    • Devices
    • Enrollments
      • Create EnrollmentPOST
      • Read EnrollmentsGET
      • Read EnrollmentGET
      • Delete EnrollmentDELETE
    • Events
    • Programs
    • Sites
  • Cloud API
logoPowered by Apidog
  1. Mobile App API
  2. Enrollments

Read Enrollments

GET/v1/site/{siteId}/enrollments

Request

Authorization: Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example
Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
Path Params
siteId
string 
required

Request samples

Responses

Successful Response(200)
Successful Response
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
array of:
id
string <uuid>
Id
required
device_ids
array[string]
required
site_id
string 
required
program_id
string <uuid>
Program Id
required
enroll_method
enum<string> 
required
Allowed values:
AUTO_ENROLLUSER_ACTION
status
enum<string> 
required
Allowed values:
ACTIVENEEDS_ACTIONPENDINGREJECTEDUNENROLLED
status_reason
string  | null 
read-onlyrequired
enrolled_at
string <date-time> | null 
Enrolled At
read-onlyrequired
unenrolled_at
string <date-time> | null 
Unenrolled At
read-onlyrequired
program_specific_attributes
array [object {2}] 
required
name
string 
required
value
string 
required
has_agreed_to_terms_and_conditions
boolean  | null 
required
terms_and_conditions_version
string  | null 
required
Example
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "device_ids": [
      "string"
    ],
    "site_id": "string",
    "program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
    "enroll_method": "AUTO_ENROLL",
    "status": "ACTIVE",
    "status_reason": "string",
    "enrolled_at": "2019-08-24T14:15:22.123Z",
    "unenrolled_at": "2019-08-24T14:15:22.123Z",
    "program_specific_attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "has_agreed_to_terms_and_conditions": true,
    "terms_and_conditions_version": "string"
  }
]
Last modified: 8 months ago