Skip to main content
Most list endpoints can be paginated with the following parameters. Check the endpoint’s reference page for where it takes them and what limits it sets.
​
integer
The 1-based page number to fetch.
​
integer
default:"25"
Records per page, up to the maximum the endpoint allows.
For example, fetching the first page of 50 accounts:

​
Two response shapes

Send either parameter and the response is a paginated envelope:
Some endpoints also return every record as a plain array when both parameters are omitted:
An endpoint that can return both declares them on its response, so a generated client covers either. Pick one before you write the code that reads it, since the two are not interchangeable.

​
Paging through a full set

Read total from the first response to know how many pages to expect, then request each in turn. Keep page_size the same across a sequence. Changing it partway through repeats or skips records, because the offset is derived from both values.