---
title: "Get details of a candidate"
method: GET
path: "/candidates/{id}"
tags: ["candidates"]
---

# Get details of a candidate

`GET /candidates/{id}`

## Request

- Base URL: `https://api.smartrecruiters.com`
- URL: `https://api.smartrecruiters.com/candidates/{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: `candidates_read`

Get details of a candidate

## Response `200`

Candidate details

- CandidateDetails
  - `id` string
  - `internal` boolean
  - `firstName` string
  - `lastName` string
  - `email` string
  - `phoneNumber` string
  - `location` CandidateLocation
    - `country` string
    - `countryCode` string
    - `regionCode` string
    - `region` string
    - `city` string
    - `lat` number, float
    - `lng` number, float
  - `web` WebProfile
    - `skype` string
    - `linkedin` string
    - `facebook` string
    - `twitter` string
    - `website` string
  - `createdOn` string, date-time
  - `updatedOn` string, date-time
  - `tags` string[]
  - `averageRating` number
  - `education` Education[]
    - `institution` string
    - `degree` string
    - `major` string
    - `current` boolean
    - `location` string
    - `startDate` string, when: date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. "2016", "2016-11", "2016-11-29"
    - `endDate` string, when: date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. "2016", "2016-11", "2016-11-29"
    - `description` string
  - `experience` Experience[]
    - `title` string
    - `company` string
    - `current` boolean
    - `startDate` string, when: date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. "2016", "2016-11", "2016-11-29"
    - `endDate` string, when: date in YYYY, YYYY-MM or YYYY-MM-dd format, ex. "2016", "2016-11", "2016-11-29"
    - `location` string
    - `description` string
  - `primaryAssignment` object: Its latest modified application from applications in non final-state. If no applications in non-final state then one in final state with most recent modification date is returned. Inactive(final) states are Lead, Rejected, Transferred, Withdrawn, Hired
    - `job` object
      - `id` string
      - `title` string
      - `actions` object
        - `details` Action, required
          - `url` string, required
          - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
        - `positionDetails` Action
          - `url` string, required
          - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
    - `status` 'LEAD' | 'NEW' | 'IN_REVIEW' | 'INTERVIEW' | 'OFFERED' | 'HIRED' | 'REJECTED' | 'WITHDRAWN' | 'TRANSFERRED'
    - `subStatus` string
    - `startsOn` string, date-time
    - `source` string
    - `reasonOfRejection` Property
      - `id` string, required
      - `label` string
    - `reasonOfWithdrawal` Property
      - `id` string, required
      - `label` string
    - `actions` object
      - `sourceDetails` Action
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
  - `secondaryAssignments` object[]: List of assignemnts (applications). Applications are sorted by state (non-final states first) and then by date. First one is excluded and is returned as primaryAssignment. Mentioned date is a date of last modification of an application eg: changed state, change of a source, reapply, anonymisation, unshare. Inactive(final) states are Lead, Rejected, Transferred, Withdrawn, Hired
    - `job` object
      - `id` string
      - `title` string
      - `actions` object
        - `details` Action, required
          - `url` string, required
          - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
        - `positionDetails` Action
          - `url` string, required
          - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
    - `status` 'LEAD' | 'NEW' | 'IN_REVIEW' | 'INTERVIEW' | 'OFFERED' | 'HIRED' | 'REJECTED' | 'WITHDRAWN' | 'TRANSFERRED'
    - `subStatus` string
    - `startsOn` string, date-time
    - `source` string
    - `reasonOfRejection` Property
      - `id` string, required
      - `label` string
    - `reasonOfWithdrawal` Property
      - `id` string, required
      - `label` string
    - `actions` object
      - `sourceDetails` Action
        - `url` string, required
        - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
  - `actions` object
    - `properties` Action, required
      - `url` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
    - `attachments` Action
      - `url` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
    - `consent` Action
      - `url` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required
    - `consents` Action
      - `url` string, required
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD' | 'CONNECT', required

## Other responses

- `401`: Candidate access denied

---

[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)