Own career site integration
Display your open PeopleForce vacancies on your own website with the Careers API.
This guide shows how to display your open PeopleForce vacancies on your own website. Whether you already have a careers page or are building one, you don't have to use the careers site provided by PeopleForce.
If you represent a job board and want to integrate your product with PeopleRecruit, see Job boards integration instead.
Prerequisites
Use the Careers API (https://app.peopleforce.io/api/careers/v1), which
exposes only non-sensitive vacancy data. You'll need a Career API key — see
Authentication.
Only ever use a Career API key on a public-facing website. A Company API key would expose worker data.
Recommended flow
- Retrieve the list of vacancies from PeopleForce.
- Retrieve filter data (locations and employment types) so candidates can filter.
- Link each vacancy to the PeopleForce careers site to apply.
1. Retrieve the list of vacancies
PeopleForce is the source of truth for your open vacancies.
curl https://app.peopleforce.io/api/careers/v1/vacancies \
-H "X-API-KEY: <your_career_api_key>"This returns the list of open vacancies.
2. Retrieve locations and employment types
Use these to build drop-down filters; both can be used to filter the vacancies list:
GET /api/careers/v1/locationsGET /api/careers/v1/employment_types
3. Link out to apply
Building a robust application form (file upload, field validation, and so on) is
complex, so we strongly recommend directing candidates to apply on the
PeopleForce careers site. Each vacancy in the List vacancies and Get a
vacancy responses includes an apply_url you can link to directly.
