Pagination

All list endpoints use page-based pagination with consistent request parameters and response structure.

Request ParametersCopy Anchor Link

Include these query parameters on any list endpoint:

Response StructureCopy Anchor Link

List endpoints return an object with items and pagination:

{
  "ok": true,
  "data": {
    "items": [],
    "pagination": {
      "page": 1,
      "limit": 25,
      "total": 142,
      "totalPages": 6
    }
  }
}

Pagination ObjectCopy Anchor Link

Best PracticesCopy Anchor Link

1. Use page and limit query parameters when making requests to list endpoints.
2. Respect the maximum limit of 100 items per page.
3. Check totalPages to know when you've reached the last page.
4. An empty items array with total: 0 means no results matched your query.

LimitationsCopy Anchor Link

• The maximum allowed limit is 100 items per page.
• If a limit greater than 100 is requested, the API will return a validation error.
• Default limit varies by resource (20 or 25) but all cap at 100.