Common query parameters
Every list endpoint accepts the following query parameters to control pagination:| Param | Type | Default | Notes |
|---|---|---|---|
limit | int | 25 | Page size; capped by your plan’s max_page_size |
page | int | 1 | Page number (page mode) |
cursor | string | — | Cursor token (cursor mode) |
paginate | string | page | Set to cursor to use cursor pagination |
Page mode
Page mode is the default. You navigate results using integer page numbers and can jump to any page directly. Each response includes ameta.pagination object with total counts and a links object with pre-built URLs for the next and previous pages.
Fetch the first page with the default page size:
Always
"page" in page mode.The current page number.
The actual number of items per page used in this response (may be less than your requested
limit if your plan caps it).Total number of items across all pages.
The number of the final page.
Full URL to the next page, or
null if you are on the last page.Full URL to the previous page, or
null if you are on the first page.links.next until it becomes null:
Cursor mode
Cursor mode is better suited for large or frequently-changing datasets. Instead of page numbers, the server returns an opaque cursor token pointing to your position in the result set. This means records are never skipped or duplicated when new items are inserted between requests — something page mode cannot guarantee. Opt in by addingpaginate=cursor to your request:
Pass this value as the
cursor query parameter to fetch the next page. null when you have reached the end of the result set.Pass this value as the
cursor query parameter to go back one page. null on the first page.cursor parameter:
meta.pagination.next_cursor is null:
Cursor tokens are opaque server-generated strings. Do not attempt to parse, decode, or construct them manually — their internal format may change without notice. Always use the cursor value exactly as returned in
meta.pagination.next_cursor or links.next.Plan caps
Your plan’smax_page_size places a hard ceiling on the limit you can request. If you pass a limit higher than your plan allows, the API silently uses your plan’s maximum instead — no error is returned.
For example, if you request limit=500 on a Starter plan (whose max_page_size is 50), the response will contain at most 50 items with meta.pagination.per_page: 50.