Skip to main content
Get a single waitlist

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required
Required range: x > 0
Example:

1

Response

200 - application/json

Object with waitlist data.

id
integer
required

Waitlist Item Id

Required range: x > 0
Example:

1

practitionerId
integer | null
required

The id of the practitioner associated to the waitlist item

Example:

12

userGroupId
integer | null
required

The id of the practitioner group associated to the waitlist item

Example:

12

locationId
integer | null
required

The id of the location associated to the waitlist item

Example:

13

patientId
integer | null
required

The id of the patient associated to the waitlist item

Example:

14

serviceIds
number[] | null
required

The id list of services the waitlist item is waiting for

Example:
waitlistTags
string[] | null
required

The waitlist tag ids of the waitlist item

Example:
preferredDays
string[]

Preferred days of the waitlist item

Example:
preferredTime
string[] | null

Preferred time of service for the waitlist item

Example:
archived
boolean | null
default:false

Whether the waitlist has been archived

createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"