Get a paged array of waitlists

id_gtinteger nullable

The starting object id of the next page

Example:200

id_ltinteger nullable

The starting object id of the previous page

Example:100

string

OR

string

OR

string

include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

practitionerIdinteger nullable

The id of the practitioner associated to the waitlist item

Example:12

userGroupIdinteger nullable

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

Example:12

locationIdinteger nullable

The id of the location associated to the waitlist item

Example:13

patientIdinteger nullable

The id of the patient associated to the waitlist item

Example:14

string

OR

string

OR

{"stackTrail":"paths:/waitlists:get:parameters:9:schema:anyOf:2","oasType":"schema","type":"unknown","nullable":true}

string

OR

string

OR

{"stackTrail":"paths:/waitlists:get:parameters:10:schema:anyOf:2","oasType":"schema","type":"unknown","nullable":true}

isActive'true' | 'false' nullable

Is the waitlist item active or closed

Example:true

preferredDaysstring[] nullable

preferredTimestring nullable

serviceIdsnumber[] nullable

waitlistTagsstring[] nullable

Response

A paged array of waitlists

Example response

{
  "data": [
    {
      "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"
      ]
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

v1

Get a paged array of waitlists

Query parameters

Response

Example response