Is there a way to retrieve a candidate’s id and link fields via API after creation?

Q&A
1

Hi all,

I’m using the Onboarding API to create candidates in Deel. When creating a candidate, I supply our own id (unique identifier in our ATS) and a link (unique ATS URL) to the candidate’s profile in our system. According to the docs, those two fields are required when calling POST /rest/v2/candidates.

After creating a candidate, the response just returns "message": "Ok" and I don’t see a way to read back the candidate record. I also couldn’t find any GET /candidates endpoint or an endpoint to fetch those fields for an existing candidate. When I try to retrieve the corresponding person from the People API, the record is returned, but the id there is not the same as the candidate id that I provided. At the moment I’m storing the candidate ID and link myself.

  • Is there an endpoint to retrieve candidate details (especially the id and link fields) after a candidate has been created?

  • Is there a way to correlate the id we provide when adding a candidate with the id returned from the People API?

Thanks in advance for any clarification.

2

Hello @blili,

Indeed at the moment there is no GET /candidates endpoint. I will raise this to the correspondent team and keep you posted on any news.