Skip to main content

Pagination

Ordering API collection operations can limit large responses, but pagination support is operation-specific. Check the operation in API Reference before sending these parameters.

Limit and offset​

Legacy collection operations can accept:

  • limit — the maximum number of records to return.
  • offset — the number of matching records to skip before returning data.
  • start — a legacy alias for offset when offset is absent.

For example, this skips the first 100 matching records and returns at most the next 100:

GET https://api.ordering.co/v400/en/YOUR_PROJECT/orders?offset=100&limit=100

If both offset and start are present, offset takes precedence.

Page and page size​

Operations that return a pagination block can instead accept:

  • page — a one-based page number.
  • page_size — the number of records requested per page, up to the operation's configured maximum.

Their response can include total, from, to, current_page, page_size, total_pages, and navigation URLs. For compatibility, the current response schema can contain both first_page and the legacy misspelling fisrt_page.

Do not combine the page-based and offset-based mechanisms unless the operation explicitly documents that combination. When page or forced pagination is active, the shared model query does not apply limit, offset, or start itself.

Orders also have a specialized Orders dashboard guide.