GETTING STARTED

Pagination

Most list endpoints return a data array plus a pagination object. The standard pattern is page-based iteration with page and limit query parameters.

Query parameters

pageintegerOptional

1-based page number. Most endpoints default to page 1.

limitintegerOptional

Page size, usually defaulting to 25 and commonly capped at 100. Check the endpoint schema for exact limits.

sort / orderstringOptional

Many list endpoints also support sort controls such as sort and order.

Response shape

PaginatedResponse.json

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 248,
    "totalPages": 10,
    "hasNext": true,
    "hasPrev": false
  }
}

Special cases

A few specialized endpoints may use a different pagination style, including cursor-based iteration. When they do, the endpoint-specific reference will document the exact parameters and response fields.