Pagination

Pagination is supported for the Entities API, Positions API, Users API, Groups API, Files API, and Archived Files API so that large result sets can be batched into multiple responses.

The maximum page size of 500 results is enforced per response. If the complete results cannot fit into a single response, the set will be truncated automatically, and the remaining values linked from the "next" URL appended to the end of the set.

Query Parameters:

Parameter

Description

Example

page[limit]

The number of results to be returned. The maximum result set size is 500.

100

page[after]

The next page; the returned paginated data must have as its first item the item that is immediately after the cursor in the results list.

10001

Links:

Name

Description

Example

"next"

The URL of the "next" page of the result set. Null if there are no additional pages.

"/v1/entities?page[limit]=100&page[after]=10001"

Example:

GET /v1/entities?page[limit]=100
HTTP/1.1 200

{
  "data": [
    ...
  ],
  "links": {
    "next": "/v1/entities?page[limit]=100&page[after]=10001"
  }
}

Updated about a year ago



Pagination


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.