List patients

Returns the members who have at least one booking with your organisation, aggregated
one row per patient and ordered by name. Each row summarises the relationship: the
locations and services they have booked, how many bookings they have with you, when
their booking activity last changed, and whether their document vault is unlocked
(documentsUnlocked — true once any booking has progressed beyond Requested).

patientId is an opaque identifier — treat it as a string and do not parse it.

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

Case-insensitive substring match on the patient's name.

string

Return only patients with at least one booking for this service.

string

Return only patients with at least one booking at this location.

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