Recruitment & ATS

Candidates, recruitment tasks, interviews and scheduling — connect your ATS.

Candidate

Endpoints

GET	/candidates	Retrieves the collection of Candidate resources.
POST	/candidates	Creates a Candidate resource.
GET	/candidates/{id}	Retrieves a Candidate resource.
PATCH	/candidates/{id}	Updates the Candidate resource.
GET	/candidates/search	Retrieves the collection of Candidate resources.

Schema fields

Field	Type	Description
firstname*	string
lastname*	string
email*	string (email)
phoneNumber	stringnull
source	stringnull
location	stringnull
birthDate	string,null (date-time)
position	stringnull
linkedinProfile	stringnull
notes	stringnull
expectations	stringnull

Recruitment Task

Endpoints

GET	/recruitment-tasks	Retrieves the collection of RecruitmentTask resources.
POST	/recruitment-tasks	Creates a RecruitmentTask resource.
GET	/recruitment-tasks/{id}	Retrieves a RecruitmentTask resource.
PATCH	/recruitment-tasks/{id}	Updates the RecruitmentTask resource.

Schema fields

Field	Type	Description
question*	string
options	arraynull
recruitmentTaskGroup	string (iri-reference)

Resource Request

Endpoints

GET	/public/resource-requests/{id}	Retrieves a ResourceRequest resource.
GET	/resource-requests	Retrieves the collection of ResourceRequest resources.
POST	/resource-requests	Creates a ResourceRequest resource.
GET	/resource-requests/{id}	Retrieves a ResourceRequest resource.
PATCH	/resource-requests/{id}	Updates the ResourceRequest resource.

Schema fields

Field	Type	Description
client	string,null (iri-reference)
status*	string
location	stringnull
position*	stringnull
description	stringnull
start	stringnull
salaryRangeMin	integernull	Value multiplied by Price::MULTIPLIER
salaryRangeMax	integernull	Value multiplied by Price::MULTIPLIER
billingType	stringnull
owners	array

Candidate Note

Endpoints

GET	/candidate-notes	Retrieves the collection of CandidateNote resources.
POST	/candidate-notes	Creates a CandidateNote resource.
GET	/candidate-notes/{id}	Retrieves a CandidateNote resource.
PATCH	/candidate-notes/{id}	Updates the CandidateNote resource.
DELETE	/candidate-notes/{id}	Removes the CandidateNote resource.

Schema fields

Field	Type	Description
id	string
employee*	string (iri-reference)
candidate*	string (iri-reference)
type*	string
note*	string
createdAt	string (date-time)
updatedAt	string (date-time)
possibleTypes	string

Recruitment Task Answer

Endpoints

GET	/recruitment-task-answers	Retrieves the collection of RecruitmentTaskAnswer resources.
POST	/recruitment-task-answers	Creates a RecruitmentTaskAnswer resource.
GET	/recruitment-task-answers/{id}	Retrieves a RecruitmentTaskAnswer resource.
PATCH	/recruitment-task-answers/{id}	Updates the RecruitmentTaskAnswer resource.

Schema fields

Field	Type	Description
answer	array
candidate	string (iri-reference)

Recruitment Task Group

Endpoints

GET	/recruitment-task-groups	Retrieves the collection of RecruitmentTaskGroup resources.
POST	/recruitment-task-groups	Creates a RecruitmentTaskGroup resource.
GET	/recruitment-task-groups/{id}	Retrieves a RecruitmentTaskGroup resource.
PATCH	/recruitment-task-groups/{id}	Updates the RecruitmentTaskGroup resource.

Schema fields

Field	Type	Description
name*	string

Resource Request Candidate

Endpoints

POST	/public/resource-request-candidates	Creates a ResourceRequestCandidate resource.
GET	/resource-request-candidates	Retrieves the collection of ResourceRequestCandidate resources.
POST	/resource-request-candidates	Creates a ResourceRequestCandidate resource.
GET	/resource-request-candidates/{id}	Retrieves a ResourceRequestCandidate resource.
PATCH	/resource-request-candidates/{id}	Updates the ResourceRequestCandidate resource.
DELETE	/resource-request-candidates/{id}	Removes the ResourceRequestCandidate resource.

Schema fields

Field	Type	Description
id	string
resourceRequest*	string,null (iri-reference)
candidate*	string,null (iri-reference)
state*	string
notify	booleannull
createdAt	string (date-time)
updatedAt	string (date-time)
possibleStates	string

Interview Slot

Endpoints

GET

/ats/scheduling/slots

Schema fields

Field	Type	Description
id	string
startTime	string (date-time)
endTime	string (date-time)
status	string

Interview Feedback

Endpoints

POST

/ats/feedback

Schema fields

Field	Type	Description
id	string
application	string (iri-reference)
authorEmployee	string (iri-reference)
stage	stringnull
rating	integernull
recommendation	string
pros	array
cons	array
createdAt	string (date-time)

ATS Scheduling Invite

Endpoints

POST

/ats/scheduling/invites

Public ATS Scheduling

Endpoints

POST	/public/ats/scheduling/{token}/book	Creates a PublicAtsScheduling resource.
GET	/public/ats/scheduling/{token}/slots	Retrieves a PublicAtsScheduling resource.

ATS Scheduling Slot Batch

Endpoints

POST

/ats/scheduling/slots

ATS Application Feedback Summary

Endpoints

GET

/ats/applications/{id}/feedback