---
title: "Get candidate property by id"
method: GET
path: "/configuration/candidate-properties/{id}"
tags: ["configuration"]
---

# Get candidate property by id

`GET /configuration/candidate-properties/{id}`

## Request

- Base URL: `https://api.smartrecruiters.com`
- URL: `https://api.smartrecruiters.com/configuration/candidate-properties/{id}`
- 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: `configuration_read`

Get candidate property details and its configuration by id.

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

## Response `200`

- CandidatePropertyDefinition
  - `id` string
  - `key` string
  - `label` string
  - `type` 'BOOLEAN' | 'COUNTRY' | 'CURRENCY' | 'DATE' | 'NUMBER' | 'PERCENT' | 'REGION' | 'TEXT' | 'USER' | 'SINGLE_SELECT' | 'MULTI_SELECT': Type of a candidate property. **[ALPHA]** `MULTI_SELECT` is available to a limited set of customers under early access.
  - `availability` CandidatePropertyAvailability
    - `toUsers` 'ALL' | 'FULL_ACCESS'
    - `context` string[]
    - `forOrgFields` CandidatePropertyFilter[]
      - `id` string
      - `values` CandidatePropertyFilterValues
        - `all` boolean
        - `content` string[]
      - `actions` Actions
  - `reference` CrossSystemDataReference: Reference to an external source system. Read-only — not modifiable through SmartRecruiters.
    - `type` string: Type of the external entity (e.g. "picklist").
    - `code` string: Code of the external entity (e.g. "ecPhoneType").
  - `actions` Actions

## Other responses

- `404`: Candidate property not found

---

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