Skip to main content
GET
/
unified
/
ats
/
candidates
List Candidates
curl --request GET \
  --url https://api.stackone.com/unified/ats/candidates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "next_page": "<string>",
  "next": "<string>",
  "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": "<string>",
      "response": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Headers

x-account-id
string
required

Query Parameters

raw
boolean | null
proxy
object | null
fields
string | null
Example:
filter
object | null
page
string | null
deprecated
page_size
string | null
next
string | null
updated_after
string<date-time> | null
deprecated
Example:
sync_token
string | null
deprecated
include
string | null
Example:

Response

data
object[]
required
next_page
string | null
deprecated
next
string | null
raw
object[] | null