Pagination

The API uses pagination for its list endpoints. List responses return a data array alongside a metadata object with pagination details. The page size is 50 items.

{
  "data": [],
  "metadata": {
    "page": 1,
    "pages": 7,
    "count": 340,
    "items": 50
  }
}

Field	Description
`page`	The current page.
`pages`	Total number of pages.
`count`	Total number of items.
`items`	Number of items on this page (50 for every page except the last, which has 1–50).

Request a specific page with the page query parameter:

curl "https://app.peopleforce.io/api/v3/employees?page=2" \
  -H "X-API-KEY: <your_api_key>"

To walk the full result set, request page=1 and keep incrementing page until it reaches pages.