List bookings

Returns your organisation's bookings, filterable by status, location, patient and date.
All filters combine with AND.

The list is served from an eventually-consistent mirror maintained for fast provider
queries; it can trail the authoritative booking record by a short moment after a
change. GET /api/v1/bookings/{bookingId} is authoritative — use it when you need the
definitive current state of a single booking.

The date filter matches a booking when the member's requestedDate is that day, or
when the date part of scheduledFor or proposedFor is that day — the same behaviour
as the portal's date search.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Return only bookings in this status (case-insensitive). Any other value returns 400 with code invalid_status. Completed and NeedsScheduling are read-only legacy statuses that can appear on historical rows.

Allowed:
string

Return only bookings at this location (exact match on locationId).

string

Return only bookings for this patient (exact match on patientId).

string
^\d{4}-\d{2}-\d{2}$

A calendar day, yyyy-MM-dd in local clinic time. Matches the requested date or the day of the scheduled/proposed appointment time.

integer
1 to 200
Defaults to 50

Maximum number of items to return per page.

string

Opaque continuation token from a previous response's nextCursor. Omit for the first page.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json