The Context Engine Studio is now open source.  View on GitHub →
Clinia
Log in
GuidesSDKsStudioAPI referenceChangelog
Patients

List patients

GET
/v1/patients

Returns a page of the patients currently registered, ordered by registry key. An empty page is returned if none have been registered yet. Graph counts are read per patient from the graph endpoints.

Authorization

Bearer read
AuthorizationBearer <token>

Each operation lists the OAuth scope (read or write) it requires.

In: header

Scope: read

Query Parameters

page?|

Zero-indexed page of patients to return. Defaults to 0.

Range0 <= value
Default0
perPage?integer

Number of patients per page. Defaults to 100; maximum is 1000.

Range1 <= value <= 1000
Default100

Response Body

application/json

curl -X GET "https://example.com/v1/patients"
{  "data": [    {      "registryKey": "string",      "patient": {        "id": "string",        "name": "string"      }    }  ],  "meta": {    "total": 0,    "page": 0,    "perPage": 0  }}