List Patients

GET

/businesses/{businessId}/patients

List Patients within a Business

Authorizations

apiKey

Parameters

Query Parameters

limit

The maximum number of patients to return. When omitted, all patients are returned.

integer

>= 1 <= 100

offset

The number of patients to skip before starting to collect the result set.

integer

0 <= 10000

Responses

200

List of patients

application/json

object

data

Array<object>

Patient

object

required

Unique identifier for the given patient.

string

businessId

required

The ID of the Business this resource belongs to.

string format: uuid

createdAt

required

Time when the resource was created (ISO 8601 format).

string format: date-time

updatedAt

required

Time when the resource was created (ISO 8601 format).

string format: date-time

archivedAt

Time when the resource was archived (ISO 8601 format).

string format: date-time

nullable

archivedReason

Reason for archiving the patient.

string

nullable

email

required

The email address of the patient.

string

name

required

The full legal name of the patient.

string

phoneMobile

The mobile phone number of the patient.

string

nullable

biologicalSex

One of:

string
null

The biological sex of the patient

string

nullable

Allowed values: FEMALE MALE OTHER

gender

The gender of the patient

string

nullable

timezone

Timezone string.

string

nullable

preferredLanguage

The preferred language of the patient

string

nullable

Allowed values: en es

dob

The date of birth of the patient (YYYY-MM-DD)

string format: date

nullable

height

The height of the patient in centimeters

number

nullable

weight

The weight of the patient in kilograms

number

nullable

activityLevel

The activity level of the patient

string | null

Allowed values: inactive exercise10Mins exercise20to60Mins exercise1to3Hours exerciseOver3Hours

cholesterol

The total cholesterol level of the patient

number

nullable

cholesterolHdl

The HDL cholesterol level of the patient

number

nullable

cholesterolLdl

The LDL cholesterol level of the patient

number

nullable

chronicMedicationStatus

The chronic medication status of the patient

string | null

Allowed values: none oneOrTwoDiseases threeOrMoreDiseases

diabetesStatus

The diabetes status of the patient

string | null

Allowed values: none preDiabetes diabetes

hypertensionTreatment

The hypertension treatment status of the patient

string | null

Allowed values: notNeeded no yes

race

The race/ethnicity of the patient

string

nullable

smokingStatus

The smoking status of the patient

string | null

Allowed values: never former current

waistCircumference

The waist circumference of the patient in centimeters

number

nullable

neckCircumference

The neck circumference of the patient in centimeters

number

nullable

hipCircumference

The hip circumference of the patient in centimeters

number

nullable

familyDiabetesHistory

The family diabetes history of the patient

string | null

Allowed values: none noneFirstDegree firstDegree

parentalHypertensionHistory

The parental hypertension history of the patient

string | null

Allowed values: none one both

historyOfHighGlucose

Whether the patient has a history of high glucose

boolean

nullable

historyOfHypertension

Whether the patient has a history of hypertension

boolean

nullable

vegetableFruitDiet

Whether the patient consumes vegetables and fruits daily

boolean

nullable

fastingGlucose

The fasting glucose level of the patient

number

nullable

triglyceride

The triglyceride level of the patient

number

nullable

customFields

Custom field values keyed by the custom field alias. See listCustomFields for the available fields. Only fields with a value are included.

object

key

additional properties

One of:

string

metadata

required

Arbitrary string key/value pairs attached to the patient. Up to 10 keys; each key up to 40 characters and each value up to 500 characters. Always present; an empty object when none are set.

object

key

additional properties

string

meta

object

totalCount

Total number of non-archived patients in the business.

integer

Example

{
  "data": [
    {
      "biologicalSex": "FEMALE",
      "timezone": "UTC",
      "preferredLanguage": "en",
      "activityLevel": "inactive",
      "chronicMedicationStatus": "none",
      "diabetesStatus": "none",
      "hypertensionTreatment": "notNeeded",
      "smokingStatus": "never",
      "familyDiabetesHistory": "none",
      "parentalHypertensionHistory": "none"
    }
  ]
}

400

The query parameters are invalid.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: BadRequestError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 400,
    "type": "BadRequestError",
    "title": "limit cannot exceed 100"
  }
}

403

The API key is missing or invalid, or the Business cannot be accessed with it.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: UnauthorizedError BusinessArchivedError BusinessDisabledError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 403,
    "type": "UnauthorizedError",
    "title": "Invalid API token"
  }
}

404

The Business does not exist.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: NotFoundError BusinessNotFoundError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 404,
    "type": "BusinessNotFoundError",
    "title": "Business not found"
  }
}