Skip to content
On this page

Pagination tips

This page explains how to use the pagination in the Kelio ATS API.

An endpoint is paginated when:

  • The payload has an X-Pagination header
  • It is clearly written on its documentation

X-Pagination header

In the Kelio ATS API responses, a X-Pagination header is added to provide useful data:

  • total-count: the total number of results
  • current-page: the number of the page received
  • next-page: the number of the next page
  • last-page: the last page of results

Querying a paginated endpoint

By default, the API will sends the first page of the results, with the 50 first results (this number may vary).

Querystring parameters can be added to specify various options. A paginated endpoint will always accept the following params:

  • page: number of the page
  • per_page: amount of results per page
  • sort: way of the results, ascending or descending
  • order: chosen field for ordering

Example

I want to see my campaigns: the second page of results, with only 10 per page, in alphabtetical order
GET https://api.talentview.fr/v2/campaigns?order=name&sort=asc&per_page=10&page=2

Customer documentation for the Kelio ATS API