Skip to main content
Many list endpoints accept pagination via PaginationData (see the live OpenAPI schema): fields are typically passed as pageNumber and pageSize (or similarly named query parameters as documented per route).

​
How to use it

  1. Start with pageNumber (often 0- or 1-based per API convention — match the parameter description on each endpoint) and a reasonable pageSize.
  2. If the response includes a full result set indicator or total count in the payload, use that to decide whether to request the next page.
  3. If the response is empty or shorter than pageSize, you have reached the last page.

​
Client tips

  • Cap pageSize to avoid timeouts and large payloads.
  • Do not assume global ordering unless the endpoint documentation states a sort order.
Exact field names can vary by route; always follow the REST API reference for the operation you are calling.