Skip to main content
Every list GET is paginated. You pick the page with two query parameters, and the meta in the response tells you whether there are more pages.
integer
default:"1"
Page number, starting at 1. An invalid value or one lower than 1 falls back to the default.
integer
default:"20"
Number of items per page. The default limit is 100. If you ask for more, you get 100, with no error.

The meta

integer
The page you received.
integer
Number of items per page actually applied, with the limit already taken into account.
boolean
true when there are records after this page.

Total count

The meta does not report the total number of records or the total number of pages. To find out whether there is another page, use hasMore. If you need to show a count on screen, add up the items you receive as you go through the pages.

Going through everything

To read every record, keep advancing page while hasMore is true.
A full sweep uses one request per page, and each one counts toward the per-minute limit. With perPage=100, you spend 1 request for every 100 records. Before increasing how often the loop runs, raise perPage.

Watch out for data that changes

Each page is calculated at the moment of the request, based on the position of the records (page × perPage). If records are created or removed between one page and the next, an item may show up twice or be left out of the sweep. For exports that need to be exact:
  • Use a fixed date range when the endpoint accepts a period filter.
  • Remove duplicates by id when combining the results.
  • Run the sweep at a quieter time of day.