Pagination

Paginated list responses

Supported list endpoints return a paginated response. Use page to select a page and page_size to request the number of results per page:

Endpoint	Returns
GET /v1/third-party/menu/	Paginated ThirdPartyDish results
GET /v1/third-party/orders/	Paginated OrderResponse results
GET /v1/third-party/hotels/rooms/	Paginated RoomType results
GET /v1/third-party/hotels/reservations/	Paginated ReservationResponse results
GET /v1/third-party/credentials/	Paginated IntegrationCredential results (owner-only)

{
  "count": 125,
  "next": "https://api.restrolab.com/v1/third-party/orders/?page=2",
  "previous": null,
  "results": [
    { "...": "first item" },
    { "...": "second item" }
  ]
}

count is the total number of matching records. next and previous contain URLs for adjacent pages, or null when there is no adjacent page. results contains the records for the current page.

To retrieve another page, follow the URL in next or previous rather than constructing URLs manually. The default and maximum page_size are defined by the API deployment and should be confirmed in the generated OpenAPI document.

Limits

Sourced from the backend implementation, not yet in the spec

The exact default and maximum page sizes should be confirmed in openapi.json for the deployment you are integrating with.

Do not assume that every page contains exactly page_size records: the final page may contain fewer results. Follow next until it is null when you need the complete result set.