Retrieve a Vitals Template

GET

/businesses/{businessId}/vitals/templates/{templateId}

const url = 'https://api.upvio.com/v1/businesses/example/vitals/templates/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.upvio.com/v1/businesses/example/vitals/templates/example \
  --header 'Authorization: Bearer <token>'

Retrieve a vitals template by ID.

Authorizations

apiKey

Parameters

Path Parameters

businessId

required

The ID of the Business.

string

templateId

required

The ID of the Vitals Template.

string

Responses

200

A Vitals Template.

application/json

object

data

object

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

Example

{
  "data": {
    "metrics": [
      "A_BODY_SHAPE_INDEX"
    ]
  }
}

400

The request is 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": "Business ID does not match API key"
  }
}

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

Vitals Template not found.

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": "NotFoundError",
    "title": "Vitals Template not found"
  }
}