Pagination
In this section, we will look at how to work with paginated responses when querying the API.
By default, all paged responses limit results to 50.
However, you can go as high as 1000 by adding a limit parameter to your requests.
The Page object
To control the pagination use the page object in the request.
Properties
- Name
page.limit- Type
- number
- Description
Limit of the resulting list of items.
- Name
page.offset- Type
- number
- Description
Offset from the start list of items that should be skipped.
Paged Result
All endpoints that support pagination return the following object as a result.
Example Response
{
"list": [
// ... items
],
"page": {
"limit": 50,
"offset": 0
},
}