Concepts
Pagination
Page / size cursor for list endpoints.
List endpoints share one pagination scheme.
Query parameters
pageintegerquerydefault: 1Page number, 1-based.
sizeintegerquerydefault: 20Items per page.
Response shape
{
"total": 250,
"pages": 13,
"current": 1,
"size": 20,
"records": [
// …items
]
}| Field | Type | Description |
|---|---|---|
total | integer | Total items across all pages |
pages | integer | Total number of pages |
current | integer | The page you just received |
size | integer | Items per page (echoes the request) |
records | array | The page contents |
When polling for new data, prefer iterating until current === pages rather than computing pages yourself — the API may add server-side filters that change the effective total.