Applications

GET /applications

Group: People Management › Applications · Operation ID: applications

Returns a list of applications. An application is one person applied to one recruitment. Create one with POST applications, or create a new applicant and their first application with POST applicants.

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

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
recruitmentId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
recruitmentName — 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
source — 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, applicantNumber, recruitmentName, status, source, lastModifiedDate
Selectable: id, applicantNumber, name, email, personId, recruitmentId, recruitmentName, positionName, status, source, lastModifiedDate

Response

200 Success

Under data, an array of applicationsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the application.
`applicantNumber`	string or null	no	The system-generated applicant number.
`name`	string or null	no	The applicant's display name.
`email`	string or null	no	The applicant's email address.
`personId`	string or null	no	The identifier of the person behind this application.
`recruitmentId`	string or null	no	The identifier of the recruitment applied to. See id on GET people/recruitments/:id.
`recruitmentName`	string or null	no	The name of the recruitment applied to.
`positionName`	string or null	no	The position or job title the recruitment hires for.
`status`	string or null	no	The status of the application. Possible values: 'draft', 'inProcess', 'waiting', 'accpeted', 'rejected', 'withdrawn', 'deleted', 'new', 'purged', 'anonymized'.
`source`	string or null	no	How the application arrived. Possible values: 'appliedDirectly', 'sourcedInternally', 'sourcedExternally', 'employeeReferral', 'externalRecruiter'.
`lastModifiedDate`	string (date-time) or null	no	The date and time the application 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