Pagination

The API uses offset-based pagination to control how many items are returned in responses that contain collections. Pagination is enabled using the query string parameter pagination in format pageLimit,offset.

Default values

pageLimit - 1000
offset - 0

Request

Equivalent to:

Examples

First Page (Offset Defaults to 0)

Equivalent to:

Explicit Offset

Behavior

Pagination applies to all endpoints that return collections

The server returns up to pageLimit items

Results start from the given offset

If the total number of items is smaller than pageLimit, fewer items are returned

Invalid pagination values may result in a 400 Bad Request

Notes and best practices

The order of returned results is defined by the endpoint’s default sorting

Very large pageLimit values may be restricted by the server

Offset-based pagination may return different results if data changes between requests

Use reasonable page sizes to improve performance and response times

Default values#

Examples#

First Page (Offset Defaults to 0)#

Explicit Offset#

Next Page#

Behavior#