New: Kith open-sources its ATS.Read why
Skip to Content
Objects

CandidateNote

A note left on a candidate's timeline: something a recruiter typed or dictated, a client's feedback, a note an agent or another system wrote. A note may be about one job or about the person in general. This is not Candidate.notes or JobCandidate.notes, which are single fields of free text.

type CandidateNote {
  agentName: String
  author: User
  candidate: Candidate!
  externalAuthorName: String
  externalId: String
  externalSource: String
  id: ID!
  job: Job
  source: String!
  text: String
  writtenAt: DateTime!
}

Fields

CandidateNote.agentName · String scalar

The name of the Kith ATS agent that wrote it, when one did.

CandidateNote.author · User object

The member who wrote it. Null for a note from an agent or another system, for older notes that recorded no author, and for a member who has left.

CandidateNote.candidate · Candidate! non-null object

The candidate it is about.

CandidateNote.externalAuthorName · String scalar

The author's name as another system gave it, for a note whose author is not a member, such as a note from Kith. For display only.

CandidateNote.externalId · String scalar

That system's own id for the note. Null for a note written in Kith ATS.

CandidateNote.externalSource · String scalar

The system the note was brought in from, such as kith or contextos. Null for a note written in Kith ATS.

CandidateNote.id · ID! non-null scalar

The note's id.

CandidateNote.job · Job object

The job it was left about. Null for a general note about the person.

CandidateNote.source · String! non-null scalar

How the note came about, in lower case: typed_note and voice_note from the app, client_feedback from a client, client_share_note for the note written for a client share, kith for a note from Kith, linkedin_sync and the like from imports. An integration may use its own word.

CandidateNote.text · String scalar

The note's words. Null for an entry that records an event without text.

CandidateNote.writtenAt · DateTime! non-null scalar

When it was written, or when what it records happened.

Member Of

AddCandidateNotePayload object · CandidateNoteEdge object · JobCandidate object