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

CandidateFilter

Which candidates to list. Every condition given must hold.

input CandidateFilter {
  currentCompany: String
  emails: [String!]
  hasCall: Boolean
  hasEmail: Boolean
  hasLinkedin: Boolean
  hasNote: Boolean
  ids: [ID!]
  isArchived: Boolean
  isEmailVerified: Boolean
  isFavourite: Boolean
  isUnassigned: Boolean
  knownByUserId: ID
  linkedinUrls: [String!]
  location: CandidateLocationFilter
  names: [String!]
  ownerIds: [ID!]
  search: String
  titleContains: String
}

Fields

CandidateFilter.currentCompany · String scalar

Only candidates whose current company is exactly this.

CandidateFilter.emails · [String!] list scalar

Only candidates with one of these email addresses. 200 at most.

CandidateFilter.hasCall · Boolean scalar

True for candidates with a linked call, false for those without.

CandidateFilter.hasEmail · Boolean scalar

True for candidates with an email address, false for those without.

CandidateFilter.hasLinkedin · Boolean scalar

True for candidates with a LinkedIn profile, false for those without.

CandidateFilter.hasNote · Boolean scalar

True for candidates with a note a person left, false for those without. An entry with no words, and call transcripts, do not count as notes.

CandidateFilter.ids · [ID!] list scalar

Only these candidates. 200 at most.

CandidateFilter.isArchived · Boolean scalar

True for archived candidates only, false for the rest. Left out, both are returned.

CandidateFilter.isEmailVerified · Boolean scalar

True for candidates whose email address has been confirmed, false for the rest.

CandidateFilter.isFavourite · Boolean scalar

True for candidates the workspace marked as exceptional, false for the rest.

CandidateFilter.isUnassigned · Boolean scalar

True for candidates with no owner, false for those with one. True cannot be combined with ownerIds.

CandidateFilter.knownByUserId · ID scalar

Only candidates this teammate knows personally.

CandidateFilter.linkedinUrls · [String!] list scalar

Only candidates with one of these LinkedIn profiles, however the address is written: the scheme, www., a trailing slash, a query and a fragment are ignored, and so is case. 200 at most.

CandidateFilter.location · CandidateLocationFilter input

Only candidates based here.

CandidateFilter.names · [String!] list scalar

Only candidates with one of these names, matched exactly. 200 at most.

CandidateFilter.ownerIds · [ID!] list scalar

Only candidates owned by one of these teammates. 200 at most.

Only candidates whose name, current title or current company contains this text, exactly as written but in any case. 200 characters at most.

CandidateFilter.titleContains · String scalar

Only candidates whose current title contains this text, in any case. 200 characters at most.

Member Of

candidates query