pagination object so your integration can determine whether more pages exist and navigate through them programmatically.
Parameters
The page number to retrieve. Must be 1 or greater. Defaults to
1 if omitted.The number of records to include per page. Accepts values from
1 to 200. Defaults to 100 if omitted.Pagination response fields
Every list response includes apagination object at the top level of the response envelope with the following fields:
The page number of the results currently returned.
The number of records included on this page.
The total number of records matching your query across all pages.
The total number of pages available given the current
per_page value.true if there is a page after the current one; false if this is the last page.true if there is a page before the current one; false if this is the first page.The index of the first record on the current page (1-based, relative to the full result set).
The index of the last record on the current page (1-based, relative to the full result set).
Example request
The following request fetches the second page of sales results with 50 records per page:Iterating all pages
To retrieve every record in a dataset, loop through pages untilhas_next is false. The example below fetches all sales for January 2025 using the maximum page size to minimize the number of requests: