Job boards integration

This guide is for job board platforms (e.g. Indeed-style sites where many companies post openings) that want to integrate with PeopleForce using an API key. It covers the endpoints, workflow, and best practices for syncing job postings and candidate applications.

Integration workflow

The customer's essential tasks are:

• Publish a job from PeopleForce to your platform.
• Receive candidate applications and sync them back to PeopleForce.

Suggested setup flow:

1. Add a settings field where customers paste their PeopleForce API key.
2. When a customer creates a job posting, let them pick from their open PeopleForce vacancies and pre-fill the details.
3. After publishing, route applicant data back to the correct PeopleForce vacancy and mark the source.

Getting started: API key

1. In PeopleForce, go to Settings → Security → API keys.
2. Generate a new key and store it securely.
3. See Authentication for details.

Importing job data

1. Prompt the customer to connect their account with an API key.
2. When creating a vacancy on your side, suggest selecting from existing PeopleForce vacancies.
3. Retrieve open vacancies and display those in a published state (state=opened).
4. Fetch the selected vacancy's details and import them (title, description, recruiter, salary, etc.).

Vacancy data mapping

Either auto-fill your job form from the imported vacancy (requires pre-mapping fields between systems) or let customers map fields manually.

Submitting candidates

When a candidate applies:

1. Collect their information (name, email, phone, CV file, cover letter, etc.).
2. Send it to PeopleForce, linked to the correct vacancy.
3. Include a source value (e.g. your platform name) for reporting.
4. Use the applications parameter to assign the candidate to the right vacancy stage.
5. If the same candidate applies to another vacancy at the same company, update the existing candidate (by ID) and add another entry to its applications.

Candidate de-duplication

• PeopleForce auto-checks for duplicates by email and CV file.
• If a duplicate is found, the candidate's information is updated.
• Manual updates via the UI are also possible.

Test environment

1. Request access to the PeopleForce test environment.
2. Use test data to simulate job sync and candidate submissions.
3. When complete, schedule a live demo with the PeopleForce team and share sandbox access for QA.

Best practices

• Validate the API key before initiating syncs.
• Clearly mark PeopleForce-originated jobs in your interface.
• Require applications via your forms (not email or redirects) to capture complete data.
• Log API errors and retry failed requests automatically.

For test access, technical support, or feedback, contact us via peopleforce.io/partners.