List Appointments

Request

Retrieves a list of all appointments.

Security

apiKeyAuth and practiceGroupId

Query

page_indexstring

page_sizestring

order_bystring

Enum:"patient_id""patient_first_name""patient_last_name""patient_full_name""practitioner_first_name""practitioner_last_name""practitioner_full_name""appointment_template_name""appointment_source""location_name"

order_descendingboolean

patient_idstring

patient_first_namestring

patient_last_namestring

patient_full_namestring

practitioner_idstring or Array of strings

One of:

string

practitioner_first_namestring

practitioner_last_namestring

practitioner_full_namestring

location_idstring or Array of strings

One of:

string

appointment_template_namestring

location_namestring

has_been_cancelledboolean

appointment_sourcestring

Enum:"Hero patient led""Hero admin led""Hero booking link""Hero booking API""EMIS""Cliniko"

start_timestring

end_timestring

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/appointments?page_index=string&page_size=string&order_by=patient_id&order_descending=true&patient_id=string&patient_first_name=string&patient_last_name=string&patient_full_name=string&practitioner_id=string&practitioner_first_name=string&practitioner_last_name=string&practitioner_full_name=string&location_id=string&appointment_template_name=string&location_name=string&has_been_cancelled=true&appointment_source=Hero%20patient%20led&start_time=string&end_time=string' \
  -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
}