Skip to content
Upvio Developer Docs

List Vitals Links

GET
/businesses/{businessId}/vitals/links

List all vitals links for a business with pagination

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
businessId
required

The ID of the Business.

string

Query Parameters

Section titled “Query Parameters ”
limit

The maximum number of links to return.

integer
default: 10 >= 1 <= 50
offset

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

integer
0 <= 10000
vitalsTemplateId

Filter by Vitals Template ID.

string
status

Filter by link status.

string
Allowed values: ACTIVE ARCHIVED DISABLED

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of Vitals Links

object
data
Array<object>
object
id
required

Unique identifier across the platform.

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 last updated (ISO 8601 format).

string format: date-time
name
required

The name of the link.

string
description

An optional description of the link.

string
nullable
slug
required

The unique slug used in the link URL.

string
status
required

The status of the link.

string
Allowed values: ACTIVE ARCHIVED DISABLED
vitalsTemplateId
required

The ID of the template this link uses.

string
scansCount
required

The number of scans performed using this link.

integer
maxScans

The maximum number of scans allowed for this link.

integer
nullable
expiresAt

When the link expires, if applicable.

string format: date-time
nullable
url
required

The full URL for this vitals link.

string format: uri
meta
object
totalCount

Total number of links matching the filter criteria.

integer