v1

latestOpenAPI 3.0.02026-07-26550199.6 KB

waitlist

Get a single waitlist

Get waitlist data by id

get/waitlists/{id}

Path parameters

idinteger required

Example:1

Response

Object with waitlist data.

idinteger required

Waitlist Item Id

practitionerIdinteger nullable required

The id of the practitioner associated to the waitlist item

userGroupIdinteger nullable required

The id of the practitioner group associated to the waitlist item

locationIdinteger nullable required

The id of the location associated to the waitlist item

patientIdinteger nullable required

The id of the patient associated to the waitlist item

serviceIdsnumber[] nullable required

The id list of services the waitlist item is waiting for

preferredDaysstring[]

Preferred days of the waitlist item

preferredTimestring[] nullable

Preferred time of service for the waitlist item

waitlistTagsstring[] nullable required

The waitlist tag ids of the waitlist item

archivedboolean nullable

Whether the waitlist has been archived

Example response

{
  "id": 1,
  "practitionerId": 12,
  "userGroupId": 12,
  "locationId": 13,
  "patientId": 14,
  "serviceIds": [
    1,
    2,
    3
  ],
  "preferredDays": [
    "Monday",
    "Tuesday"
  ],
  "preferredTime": [
    "morning",
    "afternoon",
    "evening"
  ],
  "waitlistTags": [
    "High",
    "Medium",
    "Low"
  ]
}