Pagination
How Careers API list endpoints paginate their results.
List endpoints (such as vacancies) are paginated. Each response wraps its
results in a data array alongside a metadata object describing the current
page and the total result set. The default page size is 25.
{
"data": [],
"metadata": {
"page": "1",
"per_page": "25",
"total_pages": "4",
"total_count": "92"
}
}Metadata fields
| Field | Description |
|---|---|
page | The current page number. |
per_page | Number of items returned per page. |
total_pages | Total number of pages available. |
total_count | Total number of items across all pages. |
Query parameters
| Parameter | Description |
|---|---|
page | The page number to fetch. Defaults to 1. |
per_page | Number of results per page. Defaults to 25. |
offset | Skip a number of results before the page starts. |
curl "https://app.peopleforce.io/api/careers/v1/vacancies?page=2&per_page=50" \
-H "X-API-KEY: <your_career_api_key>"To walk the full result set, request page=1 and keep incrementing page until
it reaches total_pages.