When requesting a list of objects, you may specify pagination parameters. Permissible arguments include: ‘page’ and ‘page_limit’. The argument ’page’ is synonym for ‘offset’. The argument ‘page_limit’ refers to the maximum number of objects you wish to retrieve as part of a single list objects request. The maximum number is 100; the default is 10. Here’s an example: A specified ‘page’ of 1, and a ‘page_limit’ of 20 would return the first 20 objects matching the list objects arguments specified.
The response of a list objects request has informational parameters that are useful for follow-on list objects requests; for example, your first request might be “give to me a list of the first 10 objects matching the arguments passed.” You may then wish to know whether there are more objects that match the arguments passed. You may determine this based on the response’s ‘has_more’ - a kind of “meta” value. If it is the Boolean value ‘true’, then you may retrieve a list of the next objects, by passing an incremented-by-one arguments as part of the subsequent list objects request (the ‘page_limit’ may remain unchanged).
Pagination arguments may be specified for all requests; however, they will only be used in the context of a list objects request.
URL Parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | The number of the page that you wish to retrieve OPTIONAL |
| page_limit | integer | The maximum number of objects you wish to retrieve. Default: 10. Maximum: 100. OPTIONAL |