Endpoints that accept the page and page_size query parameters are paginated. Most search endpoints and many list endpoints do:

Parameter Description
page Page number, starting at 1
page_size Results per page

Other list endpoints, such as most history, timeline and statistics endpoints, return a plain JSON array instead. Each endpoint's reference page lists the query parameters it accepts.

The Envelope

Paginated responses share the same envelope:

JSON
{
  "page": 1,
  "page_size": 25,
  "result_count": 1342,
  "results": [ ... ]
}

result_count is the total number of matches, not the number of items on the page.

Limits

Allowed values differ per endpoint. Each endpoint documents its own page and page_size limits on its reference page. Search-based endpoints return at most 10,000 results per query. To go beyond that, narrow the query with filters instead of paging further. See Search & filters.

Tip

Many search endpoints have a matching …/search:export endpoint that returns the matches as CSV or a JSON array in one response instead of pages, for example Asset Export. Large exports can time out, so narrow them with filters too.

Last updated