API Reference

Create a Booking Link

Hero Health Public API (1.0.0)

Download OpenAPI description

Download API docs

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

Booking

Operations

Links

Operations

Create an Attachment Link

Request

Creates a attachment link using the provided parameters.

Bodyapplication/jsonrequired

expiry_datestring(date-time)

ISO 8601 date format

Example: "1989-04-11"

ehr_file_idstring

File ID retrieved from List Patient Attachments endpoint. If not provided, file_data must be provided.

file_datastring

Base 64 representation of a file. Up to 2MB.

file_namestringnon-emptyrequired

patient_idstring^\d+$required

maximum_use_countnumber>= 1

curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/attachment_links \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "expiry_date": "1989-04-11",
    "ehr_file_id": "string",
    "file_data": "string",
    "file_name": "string",
    "patient_id": "string",
    "maximum_use_count": 1
  }'

Responses

Bodyapplication/json

attachment_linkstringrequired

attachment_uuidstringrequired

Response

application/json

{
  "attachment_link": "string",
  "attachment_uuid": "string"
}

Create a Booking Link

Request

Creates a booking link using the provided parameters.

Bodyapplication/jsonrequired

slot_idstring

appointment_type_idstring or Array of strings

One of:

string^\d+$

location_idstring or Array of strings

One of:

string^\d+$

patient_idstring^\d+$

practitioner_idstring or Array of strings

One of:

string^\d+$

from_datestring(date-time)

Display only the slots available after this date

Example: "1989-04-11"

to_datestring(date-time)

Display only the slots available before this date

Example: "1989-04-11"

expiry_datestring(date-time)

ISO 8601 date format

Example: "1989-04-11"

maximum_use_countnumber>= 1

link_namestring

curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking_links \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "slot_id": "string",
    "appointment_type_id": "string",
    "location_id": "string",
    "patient_id": "string",
    "practitioner_id": "string",
    "from_date": "1989-04-11",
    "to_date": "1989-04-11",
    "expiry_date": "1989-04-11",
    "maximum_use_count": 1,
    "link_name": "string"
  }'

Responses

Bodyapplication/json

booking_linkstringrequired

short_link_idstringrequired

Response

application/json

{
  "booking_link": "string",
  "short_link_id": "string"
}

Update a Booking Link

Request

Updates a booking link using the provided parameters.

Path

idstringrequired

Bodyapplication/jsonrequired

appointment_type_idstring or Array of strings

One of:

string^\d+$

location_idstring or Array of strings

One of:

string^\d+$

practitioner_idstring or Array of strings or null

One of:

string^\d+$

expiry_datestring or null(date-time)

ISO 8601 date format

Example: "1989-04-11"

maximum_use_countnumber>= 1

from_datestring or null(date-time)

Display only the slots available after this date

Example: "1989-04-11"

to_datestring or null(date-time)

Display only the slots available before this date

Example: "1989-04-11"

activeboolean

link_namestring

curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/booking_links/{id}' \
  -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": "string",
    "location_id": "string",
    "practitioner_id": "string",
    "expiry_date": "1989-04-11",
    "maximum_use_count": 1,
    "from_date": "1989-04-11",
    "to_date": "1989-04-11",
    "active": true,
    "link_name": "string"
  }'

Responses

Bodyapplication/json

booking_linkstringrequired

short_link_idstringrequired

Response

application/json

{
  "booking_link": "string",
  "short_link_id": "string"
}

Create a Form Link

Request

Creates a form link using the provided parameters.

Bodyapplication/jsonrequired

form_idstring^\d+$required

patient_idstring^\d+$

expiry_datestring(date-time)

ISO 8601 date format

Example: "1989-04-11"

maximum_use_countnumber>= 1

curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/form_links \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "form_id": "string",
    "patient_id": "string",
    "expiry_date": "1989-04-11",
    "maximum_use_count": 1
  }'

Responses

Bodyapplication/json

form_linkstringrequired

short_link_idstringrequired

Response

application/json

{
  "form_link": "string",
  "short_link_id": "string"
}

Get Link Status

Request

Get the status of a given link.

Query

urlstring

The URL of the link. Provide either 'url' or 'id'.

Example: url=https://bookings.herohealth.net/s/abc123

idstring

The ID of the short link. Provide either 'url' or 'id'.

Example: id=12345

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/links/status?id=12345&url=https%3A%2F%2Fbookings.herohealth.net%2Fs%2Fabc123' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

statusstringrequired

Enum"unused""used""partially_used""expired""disabled"

typestringrequired

Enum"booking""questionnaire""attachment""patient_reply""video"

referenceArray of objects

Response

application/json

{
  "status": "unused",
  "type": "booking",
  "reference": [
    { … }
  ]
}

Create a Video Link

Request

Creates a video link using the provided parameters.

Bodyapplication/jsonrequired

link_namestring

patient_idstring^\d+$

expiry_datestring(date-time)

ISO 8601 date format

Example: "1989-04-11"

curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/video_links \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "link_name": "string",
    "patient_id": "string",
    "expiry_date": "1989-04-11"
  }'

Responses

Bodyapplication/json

video_linkstringrequired

short_link_idstringrequired

main_room_urlstringrequired

URL of the video call room that the creator can access

Response

application/json

{
  "video_link": "string",
  "short_link_id": "string",
  "main_room_url": "string"
}

Utilities

Operations

Messages

Operations

Booking - HCA

Operations

Medical Record

Operations

Episode

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

Partners

Operations

Patients

Operations

Prescription

Operations

Subscriptions

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations

Hero Health Public API (1.0.0)

Practice Group

Admin

Booking

Links

Create an Attachment Link

Request

Responses

Was this helpful?

Create a Booking Link

RequestExpand all

Responses

Was this helpful?

Update a Booking Link

RequestExpand all

Responses

Was this helpful?

Create a Form Link

Request

Responses

Was this helpful?

Get Link Status

Request

Responses

Was this helpful?

Create a Video Link

Request

Responses

Was this helpful?

Utilities

Messages

Booking - HCA

Care Navigation

Medical Record

Episode

Form

Form Response

Invoicing

Partners

Patients

Prescription

Subscriptions

Task

Webhooks

Prescriptions

Request

Request