Guides
Pagination
Working with paginated responses
All of our list endpoints are paginated unless noted otherwise, using cursor based pagination.
Each one will return a pagination
object in the JSON response, with an example shown on the right.
In order to navigate the results, follow these steps:
- The default page size is 500 results. To change the page size, use the
per_page
query parameter. The maximum page size allowed is 1000. - To request the next page of results, use the
after
query param with theend_cursor
value of the response. - To request the previous page of results, use the
before
query param with thestart_cursor
value of the response. - To request the total count of the collection, use the
include_total_count
query param with a value oftrue
. This will complete another data query to return the total count. Expect a slightly slower response when using this option.