Candidate object

first_name

string

required

The first name of the candidate.

Minimum length: 1

last_name

string

required

The last name of the candidate.

Minimum length: 1

tags

object[]

required

A list of tags applied to the candidate.

string

The id of the candidate, format can_abc123.

full_name

string

The full name of the candidate.

string

The email address of the candidate.

phone_number

string

The phone number of the candidate.

title

string

The current job title of the candidate.

company

string

The current company of the candidate.

location

object

image_url

string

An image url to a profile picture

rating

integer | null

A 1-5 star rating assigned to the candidate.

application_ids

string[]

A list of other application ids this candidate may have. Format app_abc123.

Was this page helpful?

Suggest edits Raise issue

Change application stage Get candidates

{
  "id": "<string>",
  "full_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "title": "<string>",
  "company": "<string>",
  "location": {
    "address": "<string>",
    "country": {
      "name": "<string>",
      "code": "<string>"
    }
  },
  "image_url": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "rating": 123,
  "application_ids": [
    "<string>"
  ],
  "social_profiles": [
    {
      "type": "linked_in",
      "uri": "<string>"
    }
  ]
}

Getting Started

Endpoints

Webhooks