SMsmartrecruiters
candidates

Get candidate property values for a candidate's job

Returns

{}

when there is no value set for a candidate property.

[ALPHA] MULTI_SELECT is available to a limited set of customers under early access.

get/candidates/{id}/jobs/{jobId}/properties

Request

  • Base URL
    https://api.smartrecruiters.com
  • URL
    https://api.smartrecruiters.com/candidates/{id}/jobs/{jobId}/properties
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: candidates_read

Query parameters

context'PROFILE' | 'OFFER_FORM' | 'HIRE_FORM' | 'OFFER_APPROVAL_FORM'

context for candidate properties to display

includeMultiSelectboolean

When set to true, MULTI_SELECT type properties are included in the response. When false or omitted, MULTI_SELECT properties are excluded for backward compatibility.

[ALPHA] MULTI_SELECT is available to a limited set of customers under early access.

Response

Candidate property values.

Changes

No recorded changes to this operation across all 1 revision of this API.