Skip to content
Upvio Developer Docs

List Vitals Templates

GET
/businesses/{businessId}/vitals/templates

List all available vitals templates for a business

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
businessId
required

The ID of the Business.

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of Vitals Templates

object
data
Array<object>
object
id
required

The unique identifier for the template.

string
createdAt
required

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

string format: date-time
updatedAt
required

Time when the resource was last updated (ISO 8601 format).

string format: date-time
name
required

The name of the template.

string
description

An optional description of the template.

string
nullable
credits
required

The number of credits consumed per scan using this template.

integer
metrics
required

The metrics included in this template.

Array<string>
Allowed values: A_BODY_SHAPE_INDEX ATHEROSCLEROTIC_CVD_RISK BASAL_METABOLIC_RATE BLOOD_PRESSURE BLOOD_PRESSURE_DIASTOLIC BLOOD_PRESSURE_SYSTOLIC BMI_CLASSIFICATION BODY_FAT_PERCENTAGE BODY_ROUNDNESS_INDEX BREATHING_RATE CARDIAC_WORKLOAD CARDIOVASCULAR_EVENT_RISK CARDIOVASCULAR_RISK_SCORE CONICITY_INDEX DIABETES_RISK FATTY_LIVER_DISEASE_RISK HEART_RATE HEART_RATE_VARIABILITY HYPERTENSION_RISK PARASYMPATHETIC_ACTIVITY STRESS_INDEX TOTAL_DAILY_ENERGY_EXPENDITURE VASCULAR_AGE WAIST_TO_HEIGHT_RATIO WELLNESS_SCORE
linksCount
required

The number of links using this template.

integer
archivedAt

When the template was archived, if applicable.

string format: date-time
nullable
meta
object
totalCount

Total number of templates available.

integer