Skip to main content
GET
/
user
/
patient
/
ids
Get Patient Ids
curl --request GET \
  --url https://api.decodahealth.com/user/patient/ids \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  "<string>"
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
page
integer | null
​
per_page
integer | null
​
sort_by
string | null
​
sort_direction
enum<string> | null
Available options:
asc,
desc
​
location_id
string | null
​
id
string | null
​
external_id
string | null
​
name
string | null
​
email
string | null
​
phone_number
string | null
​
date_of_birth
(string<date-time> | string)[] | null
​
created_date
string<date-time>[] | null
​
tag_ids
string[] | null

Filter by patient tag IDs

​
location_ids
string[] | null

Filter by primary location IDs

​
lead_source
string[] | null

Filter by lead source

​
tz
string | null
​
opted_out_of_sms
string[] | null

Filter by SMS opt-out status ('true' or 'false')

​
on_scheduling_blacklist
string[] | null

Filter by scheduling blacklist status ('true' or 'false')

Response

Successful Response