Skip to main content

Pagination

List endpoints — such as GET /products, GET /client_partners, and GET /settlements — return their results in pages and use cursor-based pagination.

Requesting Pages

Query parameterDescription
sizeMaximum number of entries to return per page (1–500, default 100). Fewer entries may be returned if not enough are available.
nextCursor returned by a previous response to retrieve the following page.
previousCursor returned by a previous response to retrieve the preceding page.

Reading Responses

Each list response contains a cursors object alongside the result list:

{
"products": [ ... ],
"cursors": {
"next": "WyIyMDI1LTA3...",
"previous": null
}
}
  • cursors.next is null when there is no further page; otherwise pass it as the next query parameter to retrieve the following page.
  • cursors.previous is null when there is no page before the current one.

Usage Notes

  • Treat cursors as opaque strings. Their format is not specified and may change at any time — do not parse or construct them. Always use the values exactly as returned.
  • Cursors are short-lived by design. Use them to iterate through a result set right away; do not store them for later sessions.
  • To fetch a complete result set, request pages in a loop until cursors.next is null. Stay mindful of the rate limits when iterating over many pages.