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
practitionerId
integer | null

The id of the practitioner associated to the waitlist item

userGroupId
integer | null

The user group id of the practitioner associated to the waitlist item

locationId
integer | null

The id of the location associated to the waitlist item

patientId
integer | null

The id of the patient associated to the waitlist item

dateAddedGt

Search for waitlist item added after specified date

dateAddedLt

Search for waitlist item added before specified date

isActive
enum<string> | null

Is the waitlist item active or closed

Available options:
true,
false
preferredDays
string[] | null
preferredTime
string | null
serviceIds
number[] | null
waitlistTags
string[] | null

Response

200 - application/json
data
object[]
required
links
object
required
Get a single payment-methodGet a single waitlist