Get Job Applicant

This API allows you to retrieve job applicants in a given status.

Note that this API does not include applicant custom fields in the response. To retrieve applicant custom fields, please use the Get Job Applicant with Custom Fields API.

Localization

The following request and response fields are localized. The API considers the language of the user associated with the OAuth 2.0 application to determine the locale for these fields.

Localized Request Parameters:

  • CurrentStatus
  • JobTitle

If the value included in the query parameter does not match a localized value defined in your Cornerstone portal, the API will fall back on the default language of the portal to identify the value you sent in the query.

To understand this localization logic better, let's consider an example. Let's assume the following are true in your Cornerstone portal:

  • The language of the user acquiring the session token is defined as French (fr-FR)
  • The French value for applicant status of 'Interview' is set as 'Entrevue'
  • The default language in your portal is defined as English (US) (en-US)

With this setup, the following three outcomes are possible:

  • Scenario 1: If you send CurrentStatus=Entrevue in your API query parameter, the API will look for the localized applicant status values in French. A matching localized value of 'Entrevue' is found and the API will return applicants in 'Interview' status.
  • Scenario 2: If you send CurrentStatus=Interviewer in your API query parameter, the API will look for the localized applicant status values in French. A matching localized value of 'Interviewer' is not found. The API then looks for the value of 'Interviewer' to be defined as an applicant status in English (US), the portal's default language. The API does not find that either because the English (US) value is defined as 'Interview'. This causes the API to return an error in the response.
  • Scenario 3: If you send CurrentStatus=Interview in your API query parameter, the API will look for the localized applicant status values in French. A matching localized value of 'Interview' is not found. The API then looks for the value of 'Interview' to be defined as an applicant status in English (US), the portal's default language. The API does find it this time and returns applicants in 'Interview' status.

Localized Response Parameters:

  • ApplicationReceivedDateLocal
  • Source
  • DivisionTitle
  • PositionTitle
  • RequisitionName

OAuth 2.0 Scope: jobapplicant:read