Hired Candidate API - Technical implementation guide
The primary use case for the Hired Candidate API is to fetch data related to a hired candidate.
It allows to:
List all hired candidates, with the possibility of filtering them by a hired date, created date and whether they are “processed”
Fetch specific candidate data like personal information, structured cv data, file attachments etc.
Marking candidates as processed for future filtering purpose
Recommended work flow
The recommendation is to use the endpoint
GET /candidates/hired with its filtering option isProcessed set to false, to find a list of candidates that have recently been hired but not yet processed. Then iterate over these candidates one by one and fetch candidate details, CV-data and files attached to the candidate.
Always end the processing of each candidate with a call to the endpoint
POST /candidates/hired/{candidateId}/process
to mark the candidate as processed and make sure that it is only handled once.
Questions & Answers
How do I know what the different fields represent?
All fields exposed by the API are documented in the Complete API Docs that can be found here
https://developer.talentech.io/api-details#api=webcruiter&operation=GetHiredCandidate
Can I fetch the same candidate twice to feed data into two different systems?
This can be done in different ways, but if you would like to have two separate integrations we recommend that you use two different API clients. The endpoint POST /candidates/hired/{candidateId}/process will mark the candidate as processed by the executing API client, thus the isProcessed filter that can be applied to GET /candidates/hired will only filter candidates in the context of the executing API client.
It is possible to add a message when marking the candidate as processed. Where will this message show up?
This message will be added to the Candidate log. In Webcruiter this log can be seen on in the candidate detail view (at the bottom of the view).
What is the difference between the Hired Candidate API and the Candidate API
The endpoints in the Hired Candidate API will give the same data as the endpoints in the Candidate API. The most common use case for integrations is transferring hired candidates to an HR system. The Hire Candidate API is just a set of specialized endpoints that is convenient to use for this particular use case.
Complete API Docs
All available endpoints are documented on our developer portal