Partner API

Changelog

2024-7: Configuration from endpoint
Added
Added possibility to fetch the Job config from an endpoint.

2024-6: Added Candidate Logs
Added
Candidate Logs.
Added
Company settings can be used to send data back when a new company signs up.

2024-5: Added label field
Added
Candidate and job config can now be cleared by passing a null value to the payload.
Added
Added requisition data to the webhooks.
Added
Added label option to the config fields.

2024-4: Added internal_id
Added
Added internal_id to the candidate, job and company objects in the webhooks payload

2024-3: Added the option to add configuration per candidate
Added
Added the option to add configuration per application, which allows workflows that require extra data per candidate level.
Added
/config/companies/{company_id}/candidate endpoint to configure a candidate form.

2024-2: Included Candidate's files in the webhook data
Added
Added candidate's files, such as CV and Cover Letter to the New Candidate webhook data.

2024-1: Webhooks Update
Added
Added new webhook event type to the job. The API will now send the job data when the customer updates the job settings.

2023-7: Endpoints Added
Added
Added two new endpoints to fetch the hiring team of a job or a candidate.

2023-7: Webhooks Update
Added
Added new event type to the job . The API will now send the job data when the customer sets up the integration in a job.

2023-6: Webhooks Update
Added
Updated webhooks payload. Added new contents to the Candidate Webhook.

2023-5: Endpoint to test Company Signup Webhook
Added
/partner/_debug/trigger_company_webhooks triggers a fake company signup webhook for all the companies that enabled the integration. This endpoint is meant to be used exclusively for testing purposes. It is only available on staging.

2023-4: Endpoints renaming
Improved
/config endpoint becomes /config/webhook
Improved
/companies/<id> endpoint becomes /config/companies/<id>/job
Improved
/candidates/<id> endpoint becomes /candidates/<id>/result

2023-3: Added API version to URL
Improved
API is now available in /partner/v1/

2023-2: Endpoint update
Improved
Removed GET method on /partner/candidates/{id}

2023-1: First preview version
Added
API Preview first version