---
title: "Get candidate property values for a candidate"
method: GET
path: "/candidates/{id}/properties"
tags: ["candidates"]
deprecated: true
---

# Get candidate property values for a candidate

`GET /candidates/{id}/properties`

## Request

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

> **Deprecated.**

Please use `GET /candidates/{id}/jobs/{jobId}/properties` instead.
Returns
```
{}
```
when there is no value set for a candidate property.

## Query parameters

- `context` 'PROFILE' | 'OFFER_FORM' | 'HIRE_FORM' | 'OFFER_APPROVAL_FORM'

## Response `200`

Candidate property values.

- CandidateProperties
  - `content` CandidateProperty[]
    - `id` string, required
    - `key` string
    - `label` string, required
    - `type` 'BOOLEAN' | 'COUNTRY' | 'CURRENCY' | 'DATE' | 'NUMBER' | 'PERCENT' | 'REGION' | 'TEXT' | 'USER' | 'SINGLE_SELECT' | 'MULTI_SELECT', required: Type of a candidate property. **[ALPHA]** `MULTI_SELECT` is available to a limited set of customers under early access.
    - `value` union, required
      - string
      - boolean
      - number
      - string[]: Selected value ids for MULTI_SELECT field type
      - object
        - `code` string, required
        - `value` number, required
    - `valueLabel` string: Label of selected option for SINGLE_SELECT field type. Deprecated - use 'selectedValueLabels' field instead.
    - `selectedValueLabels` object[]: Selected values with their labels for selection field types.
      - `id` string, required: Value id
      - `label` string, required: Value label
      - `externalCode` string: Stable external identifier assigned by the source system (e.g. SuccessFactors), used to correlate values across system boundaries. Read-only — not modifiable through SmartRecruiters.
    - `actions` object, required
      - `configuration` Action, required
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required

## Other responses

- `403`: Candidate properties access denied
- `404`: with code **CANDIDATE_NOT_FOUND** when candidate does not exist

---

[API](https://skmtc.dev/smartrecruiters/apis/candidates-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/candidates-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/candidates-api/revisions/8fde9b33d46d?raw)