Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id_gt
integer | null

The starting object id of the next page

id_lt
integer | null

The starting object id of the previous page

update_gt

Search for objects updated after this date time

update_lt

Search for objects updated before this date time

include_archived
enum<string> | null
default: false

Whether archived objects should be retrieved, default is false

Available options:
true,
false
start_gt

Search for appointments start after this date time

start_lt

Search for appointments start before this date time

patientId
number | null

Search for appointments with this patient id

status
enum<string> | null

Patient status of this appointment

Available options:
Arrived,
Did not arrive,
Cancelled
status_update_gt

Search for appointments status update after this date time

status_update_lt

Search for appointments status update before this date time

Response

200 - application/json
data
object[]
required
links
object
required