The API is being built domain by domain. The reference shows what exists today.
Skip to Content
KITHDocs
ReferenceObjects

Candidate

A person a workspace knows as a possible hire. They are in the workspace's records whether or not they are on a job: see jobs for the jobs they are on.

type Candidate {
  bannerUrl: String
  createdAt: DateTime!
  currentCompany: String
  currentTitle: String
  cvUrl: String
  email: String
  favouritedAt: DateTime
  id: ID!
  isArchived: Boolean!
  isEmailVerified: Boolean!
  jobs(
    after: String
    before: String
    first: Int
    last: Int
  ): JobCandidateConnection!
  lastActivityAt: DateTime
  lastActivityKind: CandidateActivityKind
  lastCallAt: DateTime
  lastCallTitle: String
  lastNoteAt: DateTime
  linkedinUrl: String
  location: String
  locationCity: String
  locationCountryCode: String
  locationRegion: String
  name: String!
  notes: String
  phone: String
  photoUrl: String
  salary: String
  source: String
  tags: [String!]!
  updatedAt: DateTime!
  yearsExperience: Int
}

Fields

The banner image from their profile.

Candidate.createdAt · DateTime! non-null scalar

When they were added to the workspace.

Candidate.currentCompany · String scalar

The name of the company they work at today.

Candidate.currentTitle · String scalar

Their job title today.

Candidate.cvUrl · String scalar

A link to their CV.

Candidate.email · String scalar

Their email address.

Candidate.favouritedAt · DateTime scalar

When the workspace marked them as exceptional. Null when it has not.

Candidate.id · ID! non-null scalar

The candidate's id, as in their URL in the app.

Candidate.isArchived · Boolean! non-null scalar

True when they have been put away and are left out of everyday lists.

Candidate.isEmailVerified · Boolean! non-null scalar

True when an enrichment provider confirmed the email address reaches them.

Candidate.jobs · JobCandidateConnection! non-null object

The jobs they are on, each with their stage, grade and decision there, in the order they were added.

Candidate.jobs.after · String scalar

Return the rows that follow this cursor.

Candidate.jobs.before · String scalar

Return the rows that come before this cursor.

Candidate.jobs.first · Int scalar

How many rows to return, from the start or from after. 50 when left out, 200 at most.

Candidate.jobs.last · Int scalar

How many rows to return, counting back from the end or from before. 200 at most.

Candidate.lastActivityAt · DateTime scalar

When anything last happened with them: a note, a call, a stage move or a decision.

Candidate.lastActivityKind · CandidateActivityKind enum

What that latest thing was.

Candidate.lastCallAt · DateTime scalar

When the latest recorded call with them took place.

Candidate.lastCallTitle · String scalar

The title of that latest call.

Candidate.lastNoteAt · DateTime scalar

When someone last left a note about them.

Candidate.linkedinUrl · String scalar

Their LinkedIn profile.

Candidate.location · String scalar

Where they are based, as written on their profile.

Candidate.locationCity · String scalar

The city from location, when it could be worked out.

Candidate.locationCountryCode · String scalar

The country from location, as a two-letter ISO 3166 code such as GB.

Candidate.locationRegion · String scalar

The state, county or region from location, when it could be worked out.

Candidate.name · String! non-null scalar

Their full name.

Candidate.notes · String scalar

General notes about them, apart from any job.

Candidate.phone · String scalar

Their phone number, as it was entered.

Candidate.photoUrl · String scalar

A photo of them.

Candidate.salary · String scalar

What they earn or expect, as it was written down.

Candidate.source · String scalar

How they came to be in the workspace, such as an import or the browser extension.

Candidate.tags · [String!]! non-null scalar

The workspace's own labels for them.

Candidate.updatedAt · DateTime! non-null scalar

When their record last changed.

Candidate.yearsExperience · Int scalar

How many years they have worked.

Returned By

candidate query

Member Of

CandidateEdge object · JobCandidate object

On this page