Skip to content
API Reference
/
/
Get an Appointment

Hero Health Public API (1.0.0)

The Hero Health Public API enables healthtech partners to integrate with NHS GP practices connected to EMIS Web and TPP SystmOne.

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

Get an Appointment

Request

Retrieves an appointment by its ID.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/appointments/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
patient_idstring or null^\d+$
practitioner_idstring^\d+$required
location_idstring^\d+$required
appointment_type_idstring^\d+$required
durationnumber>= 1
start_timestring or null(date-time)required
videoboolean
Default false
in_personboolean
Default false
telephoneboolean
Default false
video_urlstring or null
link_idstring or null
reserved_untilstring or null(date-time)
booking_confirmed_atstring or null(date-time)
can_be_cancelledboolean
Default false
can_be_rescheduledboolean
Default false
cancellation_policy_hoursnumber
suppress_mailboolean
Default false
reasonstring or nullrequired
appointment_template_namestring or nullrequired
location_namestring or nullrequired
appointment_sourcestring or nullrequired
cancelled_atstring or null(date-time)required
patientobject or null
practitionerobject or null
Response
application/json
{
  "id": "string",
  "patient_id": "string",
  "practitioner_id": "string",
  "location_id": "string",
  "appointment_type_id": "string",
  "duration": 1,
  "start_time": "2019-08-24T14:15:22Z",
  "video": false,
  "in_person": false,
  "telephone": false,
  "video_url": "string",
  "link_id": "string",
  "reserved_until": "2019-08-24T14:15:22Z",
  "booking_confirmed_at": "2019-08-24T14:15:22Z",
  "can_be_cancelled": false,
  "can_be_rescheduled": false,
  "cancellation_policy_hours": 0,
  "suppress_mail": false,
  "reason": "string",
  "appointment_template_name": "string",
  "location_name": "string",
  "appointment_source": "string",
  "cancelled_at": "2019-08-24T14:15:22Z",
  "patient": {
    "title": "Baron",
    "first_name": "string",
    "last_name": "string"
  },
  "practitioner": {
    "title": "Baron",
    "first_name": "string",
    "last_name": "string"
  }
}

Edit an Appointment

Request

Edit a non-confirmed appointment

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
start_timestring or null(date-time)required

ISO 8601 date format

Example: "1989-04-11"
durationnumberrequired
practitioner_idstring^\d+$required
suppress_availability_checkboolean
suppress_mailboolean
curl -i -X PUT \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/appointments/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "practitioner_id": "15",
    "duration": 15,
    "start_time": "2026-03-15T09:30:00Z",
    "suppress_mail": false,
    "suppress_availability_check": false
  }'

Responses

Ok

Response
No content

Create an Appointment

Request

Create an appointment reservation for a patient. The appointment is held in a reserved state until confirmed via the Book Appointment endpoint.

Flow: List Slots → Create Appointment (reserve) → Book Appointment (confirm).

If the reservation is not confirmed within the hold period, it will be automatically released.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
appointment_type_idstring^\d+$required
location_idstring^\d+$required
practitioner_idstring^\d+$required
durationnumberrequired
start_timestring or null(date-time)required

ISO 8601 date format

Example: "1989-04-11"
patient_idstring^\d+$
billpayer_idstring^\d+$
reasonstring
suppress_mailboolean
suppress_availability_checkboolean
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/appointments \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "appointment_type_id": "42",
    "location_id": "7",
    "practitioner_id": "15",
    "duration": 15,
    "start_time": "2026-03-15T09:30:00Z",
    "patient_id": "1234",
    "billpayer_id": "5678",
    "reason": "Annual health check",
    "suppress_mail": false,
    "suppress_availability_check": false
  }'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
reserved_untilstring or null(date-time)required
Response
application/json
{
  "id": "string",
  "reserved_until": "2019-08-24T14:15:22Z"
}

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.

Operations

Task

Manage tasks assigned to admin users.

Operations

Partner

Retrieve partner information and integrations.

Operations

Partners

Retrieve partner information and integrations.

Operations

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

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.

Operations

Booking - HCA

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

Operations