Request parameters
limit: how many records to return in one page. Between 1 and 100, defaulting to 25.starting_after: a cursor. Pass the id of the last record you have seen to get the records after it. Omit it on the first request.
Response fields
Every list response wraps its records in the same envelope:data: the records in this page.has_more: whether more records exist beyond this page.next_cursor: the cursor to pass asstarting_afterfor the next page, ornullon the last page.next_url: a ready-to-use relative path for the next page that already carries your current filters and limit, ornullon the last page.
Paging through every result
The simplest loop is to follownext_url. Request it as-is, and stop when it comes back null:
- Make your first request with any filters you need.
- If
next_urlis notnull, request it to get the next page. - Repeat until
next_urlisnull.
next_url keeps your filters and limit consistent across pages, so you never have to rebuild the query yourself.