Skip to main content
GET
Search available slots

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Query Parameters

appointment_type_id
string<uuid>
required

The type to search availability for, from the bookable-types list.

from
string<date-time>
required

Inclusive start of the search window, as an ISO 8601 timestamp.

to
string<date-time>
required

Exclusive end of the search window, as an ISO 8601 timestamp. At most 30 days after from.

state
string

Two-letter US state the visit takes place in. Required when the appointment type has requires_state_license; otherwise ignored.

Required string length: 2
patient_id
string<uuid>

The patient the visit is for. Optional today and will become required, so send it whenever you have it. Required now when the appointment type is insurance-backed; omitting it then is a 400 (slot_search.patient_required). When sent, a patient your organization does not manage, or that does not exist, is a 404 (patient.not_found), and each offer's slot_token then books and reserves only this patient.

render_in_timezone
string

IANA zone id (e.g. America/Los_Angeles). Adds display_start_at / display_end_at rendered in that zone; start and end stay UTC. An unknown zone is a 400 (invalid_iana_timezone).

Required string length: 1 - 64
cursor
string

Opaque after or before value from a previous response, passed back verbatim. It carries its own direction, so there is no separate paging parameter.

Maximum string length: 8192
Pattern: ^[A-Za-z0-9_-]+$
limit
default:25

Maximum slots per page. Defaults to 25. There is no declared maximum, so a larger value is accepted rather than rejected, but the page size is capped at 50 — ask for more and you get 50. Values below 1 return 400. The cap is lower here than on the other lists because every page mints one slot token per offer.

Required range: x >= 1

Response

A page of available slots.

items
object[]
required
request_id
string
required
after
string

Cursor for the next page. Absent only when there are no further pages.

before
string

Cursor for the previous page. Absent on the first page of a walk.