Pagination
Most Get All endpoints support pagination to allow fetching multiple items in bulk. Each Get All endpoint shares a common response structure.
Offset Pagination
Request
cURLGET
Query Parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
page | false | integer | 1 | Page number of the results to return. |
size | false | integer | 20 | Number of results per page to return. Maximum size of 100 results. |
Response
{
"pagination": {
"totalItems": 924,
"page": 2,
"size": 10,
"totalPages": 93
},
"data": [
{...},
{...},
{...}
]
}
Offset Pagination Object
| Attribute | Type | Description |
|---|---|---|
pagination | pagination metadata | Pagination metadata for the response |
data | array | Query results of the request. See list endpoint resource for response schema definition |
Offset Pagination Metadata Object
| Attribute | Type | Description |
|---|---|---|
totalItems | integer | Total number of items in the tenant |
page | integer | Current page number. Should match page query parameter. |
size | integer | The size of each page. Should match size query parameter. |
totalPages | integer | The total number of pages. |