GET
/
v1
/
patient
/
list

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
address
string | null

The user's primary address.

addressLineTwo
string | null

Additional address information.

addressValid
boolean | null

Whether the user's address is valid.

allergies
string[] | null

List of patient's allergies.

city
string | null

The city of the user's address.

country
string | null

The country of the user's address.

createdDate
string
required

The date and time when the user was created.

dateOfBirth
string | null

The date of birth of the patient.

email
string | null

The user's email address.

externalUserId
string | null

The user's external identifier if available.

familyHistory
string[] | null

List of patient's family medical history.

firstName
string
required

The user's first name.

id
string
required

The unique identifier for the user.

lastName
string | null

The user's last name.

medicalHistory
string[] | null

List of patient's medical history.

medications
string[] | null

List of patient's medications.

meta
object | null

Any additional metadata about the user relevant to your system.

optedOutOfSms
boolean
default: false

Indicates whether the patient has opted out of receiving SMS messages.

phoneNumber
string | null

The user's phone number.

prescriptions
string[] | null

List of patient's prescriptions.

state
string | null

The state of the user's address.

type
string
required

The type of user.

zipCode
string | null

The postal code of the user's address.