Retrieve a Vitals Link

GET

/businesses/{businessId}/vitals/links/{linkId}

const url = 'https://api.upvio.com/v1/businesses/example/vitals/links/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/links/example \
  --header 'Authorization: Bearer <token>'

Retrieve a vitals link by ID.

Authorizations

apiKey

Parameters

Path Parameters

businessId

required

The ID of the Business.

string

linkId

required

The ID of the Vitals Link.

string

Responses

200

A Vitals Link.

application/json

object

data

object

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

Example

{
  "data": {
    "status": "ACTIVE"
  }
}

400

The Vitals Link ID is malformed.

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": "Invalid platformId format."
  }
}

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 Link 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 Link not found"
  }
}