List Subscribers

Request

Retrieves a list of subscribers for a practice group.

Filter by subscription_id to list every subscriber on one subscription. Setting patient_id narrows the result to that patient, so omit it to see a subscription's other members.

Security

apiKeyAuth and practiceGroupId

Query

patient_idstring

page_indexinteger

page_sizeinteger

order_by[]Array of strings

Items Enum:"created_at""expires_on"

order_descending[]Array of strings

scheme_idstring

scheme_namestring

subscription_idstring

The subscription_id returned by List Subscriptions, with or without its M prefix (M100027 and 100027 are equivalent).

Example:subscription_id=M100027

statusstring

Enum:"cancelled""expired""active""not_started"

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/subscribers?patient_id=string&page_index=0&page_size=0&order_by%5B%5D=created_at&order_descending%5B%5D=string&scheme_id=string&scheme_name=string&subscription_id=M100027&status=cancelled' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json

dataArray of objectsrequired

countnumberrequired

Response

{
  "data": [
    { … }
  ],
  "count": 0
}