Get Candidate

curl --request GET \
  --url https://api.stackone.com/unified/ats/candidates/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "name": "Romain Sestier",
    "first_name": "Romain",
    "last_name": "Sestier",
    "email": "[email protected]",
    "emails": [
      {
        "type": "personal",
        "value": "[email protected]"
      }
    ],
    "social_links": [
      {
        "type": "linkedin",
        "url": "https://www.linkedin.com/in/romainsestier/"
      }
    ],
    "phone": "+16178294093",
    "phone_numbers": [
      {
        "type": "personal",
        "phone": "+447700112233"
      }
    ],
    "company": "Company Inc.",
    "title": "Software Engineer",
    "application_ids": [
      "123e4567-e89b-12d3-a456-426614174000",
      "523e1234-e89b-fdd2-a456-762545121101"
    ],
    "remote_application_ids": [
      "123e4567-e89b-12d3-a456-426614174000",
      "523e1234-e89b-fdd2-a456-762545121101"
    ],
    "hired_at": "2021-01-01T01:01:01.000Z",
    "country": "United States",
    "custom_fields": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Training Completion Status",
        "value": "Completed",
        "value_id": "value_456",
        "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
      }
    ],
    "tags": [
      {
        "remote_id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Gold Medalist"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

ats

candidates

{id}

Get Candidate

curl --request GET \
  --url https://api.stackone.com/unified/ats/candidates/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "name": "Romain Sestier",
    "first_name": "Romain",
    "last_name": "Sestier",
    "email": "[email protected]",
    "emails": [
      {
        "type": "personal",
        "value": "[email protected]"
      }
    ],
    "social_links": [
      {
        "type": "linkedin",
        "url": "https://www.linkedin.com/in/romainsestier/"
      }
    ],
    "phone": "+16178294093",
    "phone_numbers": [
      {
        "type": "personal",
        "phone": "+447700112233"
      }
    ],
    "company": "Company Inc.",
    "title": "Software Engineer",
    "application_ids": [
      "123e4567-e89b-12d3-a456-426614174000",
      "523e1234-e89b-fdd2-a456-762545121101"
    ],
    "remote_application_ids": [
      "123e4567-e89b-12d3-a456-426614174000",
      "523e1234-e89b-fdd2-a456-762545121101"
    ],
    "hired_at": "2021-01-01T01:01:01.000Z",
    "country": "United States",
    "custom_fields": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Training Completion Status",
        "value": "Completed",
        "value_id": "value_456",
        "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
      }
    ],
    "tags": [
      {
        "remote_id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Gold Medalist"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy

object

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,tags,created_at,updated_at,unified_custom_fields"

include

string | null

The comma separated list of fields that will be included in the response

Example:

"custom_fields"

Response

The candidate with the given identifier was retrieved.

data

object

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.name

string | null

Candidate name

Example:

"Romain Sestier"

data.first_name

string | null

Candidate first name

Example:

"Romain"

data.last_name

string | null

Candidate last name

Example:

"Sestier"

data.email

string | null

Candidate email

Example:

"[email protected]"

data.emails

object[] | null

List of candidate emails

Show child attributes

data.emails.type

string | null

Type of the email

Example:

"personal"

data.emails.value

string | null

Email value

Example:

"[email protected]"

List of candidate social links

Show child attributes

Type of the social link

Example:

"linkedin"

URL of the social link

Example:

"https://www.linkedin.com/in/romainsestier/"

data.phone

string | null

deprecated

Candidate phone number

Example:

"+16178294093"

data.phone_numbers

object[] | null

List of candidate phone numbers including the type of the number when available

Show child attributes

data.phone_numbers.type

enum<string> | null

Type of phone number

Available options:

personal,

work,

mobile,

home,

unknown,

other,

unmapped_value,

data.phone_numbers.phone

string | null

Phone number string

Example:

"+447700112233"

data.company

string | null

Candidate company

Example:

"Company Inc."

data.title

string | null

Candidate title

Example:

"Software Engineer"

data.application_ids

string[] | null

List of candidate application IDs

Example:

[
  "123e4567-e89b-12d3-a456-426614174000",
  "523e1234-e89b-fdd2-a456-762545121101"
]

data.remote_application_ids

string[] | null

Provider's list of candidate application IDs

Example:

[
  "123e4567-e89b-12d3-a456-426614174000",
  "523e1234-e89b-fdd2-a456-762545121101"
]

data.hired_at

string<date-time> | null

Candidate hired date

Example:

"2021-01-01T01:01:01.000Z"

data.country

string | null

Candidate country

Example:

"United States"

data.custom_fields

object[] | null

The candidate custom fields

Show child attributes

data.custom_fields.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.custom_fields.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.custom_fields.name

string | null

The name of the custom field.

Example:

"Training Completion Status"

data.custom_fields.value

The value associated with the custom field.

Example:

"Completed"

data.custom_fields.value_id

string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

data.custom_fields.remote_value_id

string | null

Provider's unique identifier for the value of the custom field.

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.tags

object[] | null

List of candidate tags indicating metadata associated with the candidate

Show child attributes

data.tags.remote_id

string | null

Remote ID of the tag

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.tags.name

string | null

Name of the tag

Example:

"Gold Medalist"

data.created_at

string<date-time> | null

Candidate created date

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string<date-time> | null

Candidate updated date

Example:

"2021-01-01T01:01:01.000Z"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Create Candidate Update Candidate

⌘I

Getting Started

Use Cases

API Reference

Get Candidate

Authorizations

Headers

Path Parameters

Query Parameters

Response