Skip to content
Upvio Developer Docs

List Patients

GET
/businesses/{businessId}/patients

List Patients within a Business

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “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

Section titled “ Responses ”

200

Section titled “200 ”

List of patients

object
data
Array<object>
Patient
object
id
required

Unique identifier for the given patient.

string
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:
Allowed values: FEMALE MALE OTHER
gender

The gender of the patient

string
nullable
timezone

Timezone string.

string
nullable
Example
UTC
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
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
meta
object
totalCount

Total number of non-archived patients in the business.

integer