Pagination

All list endpoints use offset-based pagination with two query parameters:

| Parameter | Type | Default | Range | Description | |-----------|------|---------|-------|-------------| | limit | integer | 10 | 1–50 | Number of items to return | | offset | integer | 0 | 0–10000 | Number of items to skip |

The response includes meta.totalCount so you can calculate the total number of pages.

Example

Fetch the second page of 20 scans:

SDK

const { data: scans, meta } =
  await client.v1.vitals.scans.list({
    limit: 20,
    offset: 20,
  })

console.log(`Page 2 of ${Math.ceil(meta.totalCount / 20)}`)

cURL

curl "https://api.upvio.com/v1/businesses/{businessId}/vitals/scans?limit=20&offset=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

{
  "data": [
    { "id": "scan_21", "status": "SUCCEEDED" },
    { "id": "scan_22", "status": "PENDING" }
  ],
  "meta": {
    "totalCount": 85
  }
}