Own career site integration
A quick guide to help you display your open vacancies on your own website.
This guide details how to display open vacancies from PeopleForce on a company website.
If you are a representative of a job board and would like to integrate your product with PeopleRecruit please refer to Job boards integration
You don't have to use career site provided by PeopleForce . Whether you already have your own website with a career site or plan to build one - we've got you covered 🙌.
Pre-requisites
We have a dedicated Career API for integrating vacancies into an external site, which ensures only non-sensitive vacancy data is available. To use our Career API you will need to create a Career API key which is detailed in the API authentication page.
Warning: Only use a Career API key for public-facing websites to avoid exposing worker data
Business Logic
For the best integration, we suggest the following steps:
- Retrieve the list of vacancies from PeopleForce.
- Retrieve filter data (location & employment type) to enable candidates to filter positions.
- Link to the PeopleForce careers site to apply for a role.
Retrieve the list of vacancies from PeopleForce
PeopleForce is the source of truth for your open vacancies.
To get the list of open vacancies, use https://app.peopleforce.io/api/careers/v1/vacancies
To learn more, check this endpoint in our API documentation: List all vacancies
Retrieve locations and employment type data from PeopleForce
We provide endpoints for retrieving all locations and employment types, allowing you to create drop-down lists for candidates to filter vacancies by. Locations and employment types can be used as filters on the list vacancies endpoint.
Link to career site to apply for a role
Building a form for applying to a vacancy is highly complex (involving file upload, many field validations etc) so. we strongly recommend directing candidates to apply for a vacancy directly on the PeopleForce career site. In the response to the List all vacancies & get a vacancy endpoints we return an apply_url, which can be used to link directly to the vacancy on the PeopleForce career site.
Updated 3 days ago
