Pagination

Burq uses cursor-based pagination on list endpoints to avoid page boundary shifts from concurrent traffic.

Cursor Parameters

Pass one of the following mutually exclusive query parameters to paginate through results:

  • starting_after — Returns the next page. Pass the ID of the last record in the current page to fetch older records.
  • ending_before — Returns the previous page. Pass the ID of the first record in the current page to fetch newer records.

You cannot provide both parameters in the same request.

Page Size

Use the limit parameter to control the number of records returned per page. The default and maximum page size is 50.

Response Structure

All list endpoints return:

{
  "data": [...],
  "has_more": true
}
  • data — Array of records for the current page, sorted by creation date descending (newest first). IDs serve as a secondary tiebreaker for deterministic ordering when creation dates match.
  • has_moretrue if there are additional records beyond the current page. This always reflects whether a "next" button should be shown, regardless of which direction you are paginating.

Example

To page through all orders:

  1. Call GET /v2/orders — returns the first page (newest records first).
  2. If has_more is true, take the id of the last record in data and call GET /v2/orders?starting_after={id}.
  3. Repeat until has_more is false.