Piloty API
  • Introduction
  • 🔓Authentication
  • 🔭Scopes and Roles
  • ⏲️Rate limits
  • 📂Pagination
  • ⁉️Errors and Status
  • 🏢COMPANIES API
    • Companies
      • GET : Companies by media
      • GET : Retrieve Company
      • POST : Create company
      • PATCH : Update company
    • Company 's fields
      • GET : List Sectors
      • GET : List Sizes
  • 💼JOBS API
    • Jobs
      • GET : Jobs by media
      • GET : Retrieve job
      • GET : Jobs opened by media
      • GET : Retrieve job opened
      • POST : Create job
      • PATCH : Update job
    • Job's fields
      • GET : List Contracts
      • GET : List Experiences
      • GET : List Educations
      • GET : List Remote policies
      • GET : List Worktimes
      • GET : List Job Categories
  • 👤USERS API
    • Users
      • GET : Users by media
  • 🧑‍💼CANDIDATES API
    • Candidates
      • GET : User candidates by media
      • GET : Job alerts
      • GET : Favoris
    • Opportunities
      • POST : Job applications - v2
      • GET : Job applications
      • 🛑Deprecated - POST : Job applications - v1
  • 📕Changelog
Powered by GitBook
On this page
  • Response pagination field
  • Example response
  • Fields
  • Request pagination field

Pagination

This is a new version of Pagination named "cursor Pagination" released on the 14th April 2024.

The previous version 'Page number Pagination" still working but will take end in Q3 2024.

Response pagination field

Example response

Please find below an example from GET : Jobs opened by media with the query parameter

{
    "total":121,
    "totalPage":2,
    "next-page":"CIMjGgIQABoJKaZ3asmVAQAAIho6GDY3ZTFhNDc4ZTc0ODNjMWI0ZDUyOWE0Yg=="
    "jobs":[...]
}

Fields

  • total: The total number of items in this request,

  • totalPage: Total number of pages

  • next-page: The cursor id for next page. If it's null next page doesn't exist

Request pagination field

Field
type
example

limit

number

The number of resources per page. Default: 100, max: 500

next-page

string

The cursor Id for the page.

Warning, if you use next-page on GET endpoint, please encode the next-page because it can be formatted with restricted URL character like '+', '/', ....

Example:

?limit=100&next-page=CIMjGgIQABoJKaZ3asmVAQAAIho6GDY3ZTFhNDc4ZTc0ODNjMWI0ZDUyOWE0Yg==

PreviousRate limitsNextErrors and Status

Last updated 1 month ago

📂