Skip to content
/Subscriptions

Hero Health Public API (1.0.0)

Download OpenAPI description
Download API docs
Languages
Servers
Mock server
https://developer.herohealth.net/_mock/apis/public-api/openapi/
Staging
https://api.staging.htech.app/
Production
https://api.herohealth.net/

Practice Group

Operations

Admin

Operations

ApiKey

Operations

Booking

Operations

Utilities

Operations

Messages

Operations

Booking - HCA

Operations

Care Navigation

Operations

Consultations

Operations

Episode

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

Partner

Operations

Partners

Operations

Patients

Operations

Prescription

Operations

Subscriptions

Operations

List Subscriptions

Request

Retrieves a list of subscriptions for a practice group.

Security
apiKeyAuth and practiceGroupId
Query
patient_idstringrequired
page_indexinteger
page_sizeinteger
order_by[]Array of strings
Items Enum"created_at""expires_on""cancelled_at""members"
order_descending[]Array of strings
scheme_idstring
scheme_namestring
statusstring
Enum"cancelled""expired""active""not_started"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/subscriptions?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&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
data[].​idstring^\d+$required
data[].​subscription_idstringrequired
data[].​schemeobjectrequired
data[].​scheme.​idstring^\d+$required
data[].​scheme.​namestringrequired
data[].​customerobject or nullrequired
data[].​customer.​idstring^\d+$required
data[].​customer.​namestringrequired
data[].​statusstringrequired
data[].​members_countnumberrequired
data[].​created_atstring or null(date-time)required
data[].​expires_atstring or nullrequired
data[].​cancelled_atstring or nullrequired
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

List Subscribers

Request

Retrieves a list of subscribers for a practice group.

Security
apiKeyAuth and practiceGroupId
Query
patient_idstringrequired
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
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=string&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
data[].​idstring^\d+$required
data[].​patientobjectrequired
data[].​patient.​idstring^\d+$required
data[].​patient.​titlestring or null
Enum"Baron""Baroness""Brigadier""Count""Colonel""Countess""Captain""Dame""The Dowager Viscountess""Dr"
data[].​patient.​first_namestringrequired
data[].​patient.​last_namestringrequired
data[].​subscriptionobjectrequired
data[].​subscription.​idstring^\d+$required
data[].​subscription.​subscription_idstringrequired
data[].​subscription.​statusstringrequired
Enum"cancelled""expired""active""not_started"
data[].​subscription.​expires_atstring or nullrequired
data[].​schemeobjectrequired
data[].​scheme.​idstring^\d+$required
data[].​scheme.​namestringrequired
data[].​created_atstring or null(date-time)required
countnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "count": 0
}

Task

Operations

Webhooks

Operations

Prescriptions

Operations