Query parameters
Send
page_size on the first request, then cursor on every request after it, copied verbatim from the previous response.
Two platform endpoints have their own bounds:
GET /api/v1/webhooks defaults to 20 with a maximum of 100, and GET /api/v1/webhooks/logs defaults to 25 with a maximum of 50. Everything else is 50 and 200.Response envelope
All three fields are always present.
The cursor is opaque. Its value is not an offset, a record ID or a timestamp, and nothing in it is stable enough to store, decode or construct.
Walking a collection
Request the first page, then follow the cursor until it comes backnull.
429, wait and retry the same cursor rather than advancing. Limits are per connector token, so paging several customers in parallel is fine; paging one customer harder is not.
The cheapest way to page less is to fetch less: filter server-side instead of discarding client-side, and on scheduled runs use modified_after to fetch only what changed. See modified_after.
What pagination does not give you
There is no total count and no page number, so a progress bar cannot be driven from the response. If you need a count, page the whole collection and count what arrives — see Reconcile Record Counts.Frequently Asked Questions
Records are missing or repeated across pages
Records are missing or repeated across pages
Check every parameter is byte-identical between requests. A sync running mid-walk also shifts the underlying data — page against a stable dataset by gating the run on the sync-completed event, see Trigger a job on completion.
The loop never terminates
The loop never terminates
The exit condition must be the absence of a cursor. Terminating on an empty
items array or a short page will either loop forever or stop early.429 partway through
429 partway through
Honor
Retry-After and resume from the cursor you were on — see Rate limits.Pages are slow with expanded relations
Pages are slow with expanded relations
expand and include_raw_data increase response size substantially at page_size=200. Drop page_size when using them.Related
- Filters - filters that must stay constant across a walk
- Rate Limits - what bounds how fast you can page
- Record Counts - counting a collection