Get Recruitment

GET /people/recruitments/{id}

Group: People Management › Recruitments · Operation ID: getRecruitment

Returns the recruitment with the given identifier. Use the recruitment's id, not its recruitmentNumber.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the recruitment to return.

Response

200 Success

Under data (getRecruitmentOutput):

Field Type Required Description
id string yes The unique identifier for the recruitment.
recruitmentNumber string no The system-generated recruitment number. Absent while none has been assigned.
name string no The name of the opening.
category string no A free-text category of the opening, for example internal, external or student.
status string, one of "active", "inactive" no The status of the opening, derived from the deadline. 'inactive' once the deadline has passed, 'active' otherwise, including when no deadline is set.
published boolean no Whether the opening is published externally. It is set by the external-publishing flow, not through this API.
unsolicited boolean no Whether this is the catch-all opening that unsolicited applications are filed against.
deadline string no The application deadline. Format YYYY-MM-DD. Absent when no deadline is set.
vacancies number no The number of vacant positions the opening covers.
departmentId string no The identifier of the department the opening belongs to. Absent when not set. See id on GET departments/:id.
departmentName string no The name of the department. Absent when not set.
positionId string no The identifier of the position being recruited for. Absent when not set. See id on GET positions/:id.
positionName string no The name of the position. Absent when not set.
teamId string no The identifier of the team. Absent when none is assigned. See id on GET people/teams/:id.
teamName string no The name of the team. Absent when none is assigned.
locationId string no The identifier of the work location. Absent when none is assigned. There is no endpoint for it.
locationName string no The name of the work location. Absent when none is assigned.
entityId string no The legal entity that will employ the hire. Absent when none is assigned.
entityName string no The name of the legal entity that will employ the hire. Absent when none is assigned.
employmentCategoryId string no The identifier of the employment category. Absent when none is assigned. There is no endpoint for it.
hiringManagerId string no The identifier of the hiring manager. Absent when none is assigned. See id on GET people/:id.
hiringManagerName string no The full name of the hiring manager. Absent when none is assigned.
ownerId string no The identifier of the recruitment owner, the recruiter. Absent when none is assigned. See id on GET people/:id.
ownerName string no The full name of the recruitment owner. Absent when none is assigned.
jobDescription string no The job description, as plain text.
viabilityCriteria string no The internal viability criteria used to screen applicants, as plain text.
website string no The URL of the posting or the hiring team's page.
relocationRequired string no Whether and how relocation is required. Free text, not a boolean.
lastModifiedDate string (date-time) yes The date and time the recruitment record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses