Skip to content
/Subscriptions

Hero Health Public API (1.0.0)

The Hero Health Public API enables healthtech partners to build products that leverage Hero Health's IM1-assured EMIS/TPP integrated functionality.

Key capabilities

  • Patient messaging — Send SMS, email, and NHS App messages on behalf of a practice
  • Appointment booking — List available slots, create reservations, and confirm bookings
  • Patient management — Register and look up patients via PDS (Personal Demographics Service)
  • Webhooks — Subscribe to events such as appointment confirmations and write-to-record outcomes
  • Booking & form links — Generate sharable links for patient self-service flows
  • Elements — Generate access tokens for embedding pre-built Hero UI components

Authentication

All endpoints require an x-api-key and x-practice-group-id header. API keys are scoped to specific functionality (messaging, booking, booking links). Contact Hero support to request your key.

Rate limits

Rate limits are defined in your Partner agreement. If you exceed your limit you will receive a 429 Too Many Requests response.

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

Manage practice group settings, access tokens, and configuration. Use the access token endpoint to generate short-lived JWTs for Hero Elements.

Operations

Patients

Register, search, and manage patient records. Supports PDS (Personal Demographics Service) lookups to trace patients against the NHS Spine.

Operations

Messages

Send SMS, email, NHS App, and Hero-only messages to patients. Supports write-to-record to persist messages in the patient's EHR.

Operations

Booking

Create appointment reservations, confirm bookings, cancel, and reschedule. Query available slots filtered by location, practitioner, and appointment type.

Operations

Episode

Manage clinical episodes — containers for related patient interactions and messages.

Operations

Care Navigation

Manage care navigation pathways and patient submissions for triage workflows.

Operations

Prescription

Create and manage prescriptions.

Operations

Prescriptions

List and manage prescriptions.

Operations

WriteToRecord

Check the status of write-to-record operations for messages sent to the EHR.

Operations

Admin

Manage admin users, signatures, and preferences within a practice group.

Operations

ApiKey

List and manage API keys for your practice group.

Task

Manage tasks assigned to admin users.

Operations

Partner

Retrieve partner information and integrations.

Operations

Partners

Retrieve partner information and integrations.

Form

List and retrieve forms (questionnaires) configured for a practice group.

Operations

Form Response

Create, retrieve, and update form responses submitted by patients.

Operations

Subscriptions

Manage notification subscriptions and subscribers.

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
}

Webhooks

Subscribe to Hero events (e.g. appointment confirmations, write-to-record outcomes) and receive real-time notifications via HTTP callbacks.

Operations

Invoicing

Manage invoicing customers, products, coupons, and membership schemes.

Operations

Utilities

Utility endpoints for address lookup and SNOMED code validation.

Booking - HCA

Specialist booking endpoints for HCA (Healthcare Assistant) diary consultants and appointments.

Operations