Skip to main content

Pagination

Every endpoint that returns a list of items supports pagination. This means that the response contains only a subset of the total items, and you can request additional pages of results.

Some endpoints support pagination parameters:​

  • skip: The number of items to skip before starting to collect the result set (default is 0).
  • limit: The maximum number of items to return per page (default depends on the endpoint you are using ).

Example:​

Example of how to use pagination parameters in a request to the API, here in eventgroup endpoint:

curl -X 'GET' \
  'https://demo.empplan.io/public/v1/api/eventgroup/all?limit=100&skip=10&project_name=demo' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  {your_token}'

Response:​

Some endpoints returns always the total count of items availaible on server, so you can calculate how many pages of results there are based on the limit parameter. The response will include a total field that indicates the total number of items available, and a data field that contains the current page of results.