By default all "List" endpoints return paginated results. You may use the query params after_cursor
and per_page
to control the number of results you see. For per_page
the default will be 25 but can optionally be increased to a maximum of 100.
When reading paginated responses from the API, the following response headers will also be sent:
Header | Description |
---|---|
X-After-Cursor | The next cursor value to retrieve more results. If null, then there are no more pages of results to retrieve.* |
X-Per-Page | The current per_page |
*We make a best effort to respect X-Per-Page
, but sometimes you may receive less than or more than that number of records. You may also receive blank pages while paginating. Always continue pagination until you receive a blank X-After-Cursor
header to ensure records are not missed.