Returns a list of recruitments.

GET /people/recruitments

Group: People Management › Recruitments · Operation ID: recruitments

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`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
name — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
category — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
published — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
unsolicited — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
deadline — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
vacancies — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
departmentId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
positionId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
teamId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
locationId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
employmentCategoryId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
hiringManagerId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
ownerId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, recruitmentNumber, name, category, status, published, unsolicited, deadline, vacancies, lastModifiedDate
Selectable: id, recruitmentNumber, name, category, status, published, unsolicited, deadline, vacancies, departmentId, departmentName, positionId, positionName, teamId, teamName, locationId, locationName, entityId, entityName, employmentCategoryId, hiringManagerId, hiringManagerName, ownerId, ownerName, jobDescription, viabilityCriteria, website, relocationRequired, lastModifiedDate

Response

200 Success

Under data, an array of recruitmentsRow:

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

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error