GET
/
v1
/
patient
/
list
Patient List
curl --request GET \
  --url https://api.decodahealth.com/v1/patient/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "address": "<string>",
    "addressLineTwo": "<string>",
    "addressValid": true,
    "allergies": [
      "<string>"
    ],
    "city": "<string>",
    "country": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "dateOfBirth": "2023-12-25",
    "email": "<string>",
    "externalUserId": "<string>",
    "familyHistory": [
      "<string>"
    ],
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "medicalHistory": [
      "<string>"
    ],
    "medications": [
      "<string>"
    ],
    "meta": {},
    "optedOutOfSms": false,
    "phoneNumber": "<string>",
    "prescriptions": [
      "<string>"
    ],
    "state": "<string>",
    "type": "<string>",
    "zipCode": "<string>"
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Query Parameters

​
search_term
string | null

Search for a patient by name, phone number, or id.

​
external_user_id
string | null

The external user ID to filter by

​
n
integer | null
default:10

Number of results to return, ordered by createdDate

Response

200
application/json

Successful Response

The response is of type PatientSummary · object[].