Skip to main content
GET
List appointments

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Query Parameters

page
integer
Required range: x >= 1
page_size
integer
Required range: 1 <= x <= 100
cursor
string

Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.

sort
string

attr[,attr]:asc|desc — sortable: id, appointment_type_id, practitioner_id, patient_id, location_id, status, updated, created

id
string

Filter: operator:value

appointment_type_id
string

Filter: operator:value

practitioner_id
string

Filter: operator:value

resource_id
string

Filter: operator:value

columns
string

Filter: operator:value

patient_id
string

Filter: operator:value

location_id
string

Filter: operator:value

start
string

Filter: operator:value

end
string

Filter: operator:value

status
string

Filter: operator:value

note
string

Filter: operator:value

is_group
string

Filter: operator:value

group_master_id
string

Filter: operator:value

group_total_attendees
string

Filter: operator:value

cancel_date
string

Filter: operator:value

cancel_note
string

Filter: operator:value

updated
string

Filter: operator:value

created
string

Filter: operator:value

metadata
object

Filter by integrator metadata: metadata[key]=operator:value

Response

Page of appointments

data
object[]
meta
object