Check waitlist length

GET 
/v1/partner/locations/:location_id/waitlist-length

Returns the current number of patients on the waitlist for a given location. Returns an array containing a single object with the waitlist length and location ID. Useful for real-time capacity management and patient expectations.

Token scope:

{'scope': 'read:locations'}

Request

Path Parameters

location_id Location Idrequired

Required. The unique identifier of the location

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

location_id Location Id (integer)required

Possible values: Value must match regular expression ^[a-zA-Z0-9]{6}$

The unique identifier of the location

waitlist_length Waitlist Length (integer)required

The number of patients currently on the waitlist

• ]

Example (from schema)

[
  {
    "location_id": 0,
    "waitlist_length": 0
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...