Skip to content

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.

Fetch the second page of 20 scans:

const { data: scans, meta } =
await client.v1.vitals.scans.list({
limit: 20,
offset: 20,
})
console.log(`Page 2 of ${Math.ceil(meta.totalCount / 20)}`)

Response:

{
"data": [
{
"id": "ckq7v1w1k0008zqxk7g3l5n2q",
"createdAt": "2026-02-04T09:01:12.000Z",
"patientId": "ckq7v1w1k0004zqxk9j4h2g6r",
"vitalsLinkId": "ckq7v1w1k0007zqxk2d6f9h1j",
"status": "SUCCEEDED"
},
{
"id": "ckq7v1w1k0009zqxk3m7c4b8d",
"createdAt": "2026-02-04T09:31:02.000Z",
"patientId": "ckq7v1w1k0004zqxk9j4h2g6r",
"vitalsLinkId": "ckq7v1w1k0007zqxk2d6f9h1j",
"status": "PENDING"
}
],
"meta": {
"totalCount": 85
}
}

Scan objects are trimmed for brevity. See List vitals scans for the full shape.