Get Candidate

GET

unified

ats

candidates

{id}

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": "sestier.romain123@gmail.com",
    "emails": [
      {
        "type": "personal",
        "value": "sestier.romain123@gmail.com"
      }
    ],
    "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"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "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

default:false

Indicates that the raw request result is returned

proxy

object | null

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,created_at,updated_at"

include

string | null

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

Example:

"custom_fields"

Response

200

application/json

The candidate with the given identifier was retrieved.

data

object

required

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 | null

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:

"sestier.romain123@gmail.com"

data.emails

object[] | null

List of candidate emails

List of candidate social links

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

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

data.created_at

string | null

Candidate created date

Example:

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

data.updated_at

string | null

Candidate updated date

Example:

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

raw

object[] | null

Was this page helpful?

Suggest edits

Create Candidate List Candidates

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": "sestier.romain123@gmail.com",
    "emails": [
      {
        "type": "personal",
        "value": "sestier.romain123@gmail.com"
      }
    ],
    "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"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

ATS

Common Guides

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response