Get a paged array of waitlists

curl --request GET \
  --url https://api.splose.com/v1/waitlists \
  --header 'Authorization: Bearer <token>'

{
  "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"
      ],
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Authorizations

Authorization

string

header

required

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

Example:

200

id_lt

integer | null

The starting object id of the previous page

Example:

100

update_gt

Search for objects updated after this date time

Example:

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

update_lt

Search for objects updated before this date time

Example:

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

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

Example:

12

userGroupId

integer | null

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

Example:

12

locationId

integer | null

The id of the location associated to the waitlist item

Example:

13

patientId

integer | null

The id of the patient associated to the waitlist item

Example:

14

dateAddedGt

Search for waitlist item added after specified date

Example:

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

dateAddedLt

Search for waitlist item added before specified date

Example:

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

isActive

enum<string> | null

Is the waitlist item active or closed

Available options:

true,

false

Example:

"true"

preferredDays

string[] | null

preferredTime

string | null

serviceIds

number[] | null

waitlistTags

string[] | null

Response

200 - application/json

A paged array of waitlists

data

object[]

required

data.id

integer

required

Waitlist Item Id

Required range: x > 0

Example:

1

data.practitionerId

integer | null

required

The id of the practitioner associated to the waitlist item

Example:

12

data.userGroupId

integer | null

required

The id of the practitioner group associated to the waitlist item

Example:

12

data.locationId

integer | null

required

The id of the location associated to the waitlist item

Example:

13

data.patientId

integer | null

required

The id of the patient associated to the waitlist item

Example:

14

data.serviceIds

number[] | null

required

The id list of services the waitlist item is waiting for

Example:

[1, 2, 3]

data.preferredDays

string[]

required

Preferred days of the waitlist item

Example:

["Monday", "Tuesday"]

data.waitlistTags

string[] | null

required

The waitlist tag ids of the waitlist item

Example:

["High", "Medium", "Low"]

data.preferredTime

string[] | null

Preferred time of service for the waitlist item

Example:

["morning", "afternoon", "evening"]

data.createdAt

Object creation date time

Example:

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

data.updatedAt

Object update date time

Example:

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

links

object

required

Get a single payment-method Get a single waitlist

curl --request GET \
  --url https://api.splose.com/v1/waitlists \
  --header 'Authorization: Bearer <token>'

{
  "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"
      ],
      "createdAt": "2023-07-30T09:00:00.000Z",
      "updatedAt": "2023-07-30T09:00:00.000Z"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}

Get started

API Reference

Authorizations

Query Parameters

Response