Skip to main content
GET
List patients

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

name
string | null
Maximum string length: 200
email
string<email>

Filter to patients by email address. Normalized to lowercase; must be a valid email address.

Maximum string length: 254
active
cursor
string

Opaque pagination token. Pass back the after (next page) or before (previous page) value from a prior response's envelope to fetch that page. Do not construct or decode it.

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

Response

OK

items
object[]
required
request_id
string
required
after
string

Forward pagination cursor. Present when more results follow; absent on the last page. To fetch the next page, send this exact value back as the cursor query parameter (note the different name) — do not send it as after. Opaque; do not construct or decode it.

before
string

Backward pagination cursor for the previous page, when available. Send this value back as the cursor query parameter (same cursor param as forward paging; there is no separate before parameter). Opaque; do not construct or decode it.