Pagination

We support OData pagination using $top and $skip as part of the query string.

curl https://api.urus.co.uk/hr/v2/employees?$skip=250&$top=250 \
-H "authorization: Bearer <access token>" \

The number of records per Page is different per endpoint. The table in this topic shows what the max record counts are per endpoint. You can request fewer records per page, but you cannot change the built-in maximum.

You can optionally include a header instead of $top, to override the default page size:

curl https://api.iris.co.uk/hr/v2/employees \
-H "authorization: Bearer <access token>" \
-H "prefer: odata.maxpagesize=1"

When using the $skip as part of the request url, we recommend you include the $top parameter even if it is the same as the max number of records returned. This is because the default number of returned records could increase in future.

Max records per endpoint