Skip to main content
GET
List appointments (agenda)

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Query Parameters

startFrom
string | null

ISO-8601 lower bound on start (inclusive).

startTo
string | null

ISO-8601 upper bound on start (inclusive).

status
enum<string>[] | null

Filter by one or more statuses (repeatable).

FHIR appointment status set (mirrors datalayer AppointmentStatus). Used to validate the agenda status filter, so a typo is a clean 400, not a 5xx.

Available options:
proposed,
pending,
booked,
arrived,
checkedIn,
fulfilled,
cancelled,
noshow,
waitlist,
enteredInError
consultationInternalId
string | null

Filter to the booking that carries this consultation id.

page
integer
default:1

Page number (1-based).

Required range: x >= 1
limit
integer
default:20

Number of items per page.

Required range: 1 <= x <= 50

Response

Successful Response

Paginated list of appointments (the agenda).

items
AppointmentResponse · object[]
required

Page of appointments.

page
integer
required

Current page number (1-based).

limit
integer
required

Number of items per page.

hasMore
boolean
required

Whether another page likely exists (accurate on every page).

total
integer | null

Total appointments matching the filter (null on later pages).

totalPages
integer | null

Total number of pages (null when the total is unknown).