Skip to main content
GET
List patients

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Query Parameters

page
integer
Required range: x >= 1
page_size
integer
Required range: 1 <= x <= 100
cursor
string

Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.

sort
string

attr[,attr]:asc|desc — sortable: id, dob, updated, created

id
string

Filter: operator:value

imported_id
string

Filter: operator:value

custom_reference
string

Filter: operator:value

first_name
string

Filter: operator:value

last_name
string

Filter: operator:value

preferred_name
string

Filter: operator:value

dob
string

Filter: operator:value

email
string

Filter: operator:value

sex
string

Filter: operator:value

balance
string

Filter: operator:value

private_balance
string

Filter: operator:value

third_party_balance
string

Filter: operator:value

updated
string

Filter: operator:value

created
string

Filter: operator:value

communication_status
string

Filter: operator:value

patient_status
string

Filter: operator:value

locale
string

Filter: operator:value

referral_source_id
string

Filter: operator:value

referral_source_type
string

Filter: operator:value

note
string

Filter: operator:value

default_location
string

Filter: operator:value

firebase_id
string

Filter: operator:value

app_signup
string

Filter: operator:value

app_last_accessed
string

Filter: operator:value

blocked
string

Filter: operator:value

metadata
object

Filter by integrator metadata: metadata[key]=operator:value

Response

Page of patients

data
object[]
meta
object