This guide describes the query parameters and response shape for paginated list operations. When a result set can be large, use pagination to limit the size of each response.

Query parameters

Defaults

Unless an operation documents otherwise:

• limit defaults to 100

• page defaults to 1

There is no maximum enforced on limit; request only as many items as you need per page.

Response

Paginated responses include a data array along with top-level pagination fields:

• page — current page number

• resultCount — total number of rows matching the query, before paging

• pageCount — number of pages, generally Math.ceil(resultCount / limit)

When resultCount is 0, pageCount may be reported as 0 or 1 depending on the endpoint. Use resultCount or data.length rather than pageCountendpoint to decide whether more pages are available.

{
  "data": [ /* … */ ],
  "page": 1,
  "resultCount": 42,
  "pageCount": 1
}

Related guides

• Errors — What a failed request looks like.