Pagination and sorting

pagination[limit]

Defines the maximum number of results to return. For example, pagination[limit]=100. The default value varies with different resources.

pagination[offset]

Defines the number of results you want to skip before getting the results you need. For example, pagination[offset]=10. The default value for most endpoints is 0.

pagination[sortBy]

Defines the property by which to sort results. For example, pagination[sortBy]=id. By default, results are usually sorted by name or id.

pagination[sortDir]

Defines the sorting order. Use asc for ascending order, use desc for descending order. The default ordering direction is usually ascending.

Example:

Let’s say we want to retrieve data stores that belong to the team with ID 212.

1

The request URL with the default pagination settings looks as follows:

/api/v2/orders

2

Add the pagination parameters.

In this case, we want to skip the first 20 results, limit the results to 25 data stores and sort them in ascending order. Use the following query parameters:

&pagination%5Boffset%5D=20&pagination%5BsortDir%5D=asc&pagination%5Blimit%5D=25

3

The full request URL looks like this:

/api/v2/orders&pagination%5Boffset%5D=20&pagination%5BsortDir%5D=asc&pagination%5Blimit%5D=25