Skip to content

Pagination

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

ParameterTypeDefaultRangeDescription
limitinteger101–50Number of items to return
offsetinteger00–10000Number 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": "scan_21", "status": "SUCCEEDED" },
{ "id": "scan_22", "status": "PENDING" }
],
"meta": {
"totalCount": 85
}
}