This section aims at presenting all the base endpoints that are part of the SmartRecruiters Candidate API.
Available endpoints:
- /candidates – list – method for searching and listing candidates
- /candidates – details – method for getting details of a candidate
- /candidates – insert – method for creating a new candidate and assigning to a Talent Pool
- /jobs/{jobId}/candidates – insert – method for creating a new candidate and assigning to a Job
- /candidates /attachments – list – method to list attachments for a candidate with a given id
- /candidates /attachments – download – method returns a candidate’s attachment
- /candidates /attachments – insert – method allows attaching files to a candidate’s profile
In an effort to make things consistent, we present each of these methods using the structure below:
- Request – GET method to communicate to our API
- Path Parameters – all of these are required
- Query Parameters – all of these are optional
- Response Body
- Example http request
- Example response