---
title: "Get a paged array of waitlists"
method: GET
path: "/waitlists"
tags: ["waitlist"]
---

# Get a paged array of waitlists

`GET /waitlists`

Get a paged array of waitlists

## Query parameters

- `id_gt` integer, nullable — The starting object id of the next page
- `id_lt` integer, nullable — The starting object id of the previous page
- `update_gt` union — Search for objects updated after this date time
  - string
  - string
- `update_lt` union — Search for objects updated before this date time
  - string
  - string
- `include_archived` 'true' | 'false', nullable — Whether archived objects should be retrieved, default is false
- `practitionerId` integer, nullable — The id of the practitioner associated to the waitlist item
- `userGroupId` integer, nullable — The user group id of the practitioner associated to the waitlist item
- `locationId` integer, nullable — The id of the location associated to the waitlist item
- `patientId` integer, nullable — The id of the patient associated to the waitlist item
- `dateAddedGt` union — Search for waitlist item added after specified date
  - string
  - string
  - unknown
- `dateAddedLt` union — Search for waitlist item added before specified date
  - string
  - string
  - unknown
- `isActive` 'true' | 'false', nullable — Is the waitlist item active or closed
- `preferredDays` string[], nullable
- `preferredTime` string, nullable
- `serviceIds` number[], nullable
- `waitlistTags` string[], nullable

## Response `200`

A paged array of waitlists

- object
  - `data` object[], required
    - `id` integer, required — Waitlist Item Id
    - `practitionerId` integer, nullable, required — The id of the practitioner associated to the waitlist item
    - `userGroupId` integer, nullable, required — The id of the practitioner group associated to the waitlist item
    - `locationId` integer, nullable, required — The id of the location associated to the waitlist item
    - `patientId` integer, nullable, required — The id of the patient associated to the waitlist item
    - `serviceIds` number[], nullable, required — The id list of services the waitlist item is waiting for
    - `preferredDays` string[] — Preferred days of the waitlist item
    - `preferredTime` string[], nullable — Preferred time of service for the waitlist item
    - `waitlistTags` string[], nullable, required — The waitlist tag ids of the waitlist item
    - `archived` boolean, nullable — Whether the waitlist has been archived
    - `createdAt` union — Object creation date time
      - string
      - string
    - `updatedAt` union — Object update date time
      - string
      - string
  - `links` object, required
    - `previousPage` string — The link to retrieve next page
    - `nextPage` string — The link to retrieve previous page

---

[API](https://skmtc.dev/splose/apis/splose-public-api.md) · [All operations](https://skmtc.dev/splose/apis/splose-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/splose/splose-public-api/revisions/648d60075f00/schema)