---
title: "Get Candidate By Id"
method: GET
path: "/api/ats/v1/candidates/{id}"
tags: ["Candidate"]
---

# Get Candidate By Id

`GET /api/ats/v1/candidates/{id}`

Returns a Candidate object with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `include_raw_data` boolean — Include raw data in the response
- `include_custom_fields` boolean — Whether to include custom fields in the response.
- `expand` string — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

## Headers

- `x-connector-token` string, required

## Response `200`

Successful Response

- AtsCandidate
  - `id` string, uuid, required
  - `remote_id` string, nullable, required — The third-party API ID of the matching object.
  - `modified_at` string, required — This is the datetime that this object was last updated by Bindbee
  - `raw_data` object, nullable — This is the Raw data
  - `custom_fields` object, nullable, required — The custom fields related to the model
  - `first_name` string, nullable — The candidate's first name.
  - `last_name` string, nullable — The candidate's last name.
  - `company` string, nullable — The name of the company where candidate has applied.
  - `title` string, nullable — The position for which the candidate has applied
  - `last_interaction_at` string, nullable — The date of the last interaction with the candidate.
  - `is_private` boolean, nullable — Whether the candidate's information is private.
  - `can_email` boolean, nullable — Whether the candidate can be emailed.
  - `locations` string[], nullable — The location of the candidate.
  - `phone_numbers` string[], nullable — The candidate's phone numbers.
  - `email_addresses` string[], nullable — The candidate's email addresses.
  - `urls` AtsUrl[], nullable — The candidate's URLs. This can include a personal website, LinkedIn profile, or other relevant URLs.
    - `value` string, nullable, required — The site's url.
    - `url_type` 'PERSONAL' | 'COMPANY' | 'PORTFOLIO' | 'BLOG' | 'SOCIAL_MEDIA' | 'OTHER' | 'JOB_POSTING' | '-', nullable, required — The type of site. If the value is not one of the defined enum values, the original value passed through will be returned.
  - `tags` string[], nullable — The candidate's tags. Tags are used to categorize candidates and can be used to filter candidates in the UI.
  - `applications` unknown[], nullable — The candidate's applications.
    - unknown
  - `attachments` unknown[], nullable — The candidate's attachments.
    - unknown
  - `remote_created_at` string, nullable — When the third party's candidate was created.
  - `remote_updated_at` string, nullable — When the third party's candidate was last updated.
  - `avatar` string, nullable — The candidate's avatar.

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `404` — The requested resource was not found.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/revisions/7da10dc93a21/schema)