The SEEK API lets you retrieve information about a candidate and their profile related to a particular application.
When a candidate applies for a job ad they consent to a snapshot of their SEEK profile being shared with the hirer.
SEEK recommends that any retrieved candidate information only be available for viewing under the job ad that the application was related to.
If you decide to persist a general candidate profile in your software, it must be scoped to the SEEK hirer that received the application.
Before you start working with candidate profiles, you will need to request a partner token.
The
CandidateProfile object links to:- The candidate that the profile belongs to via the
CandidateProfile.candidatefield.Candidate.personcontains the candidate’s name, email address and phone number.This field is connected to the candidate’s live SEEK profile; the query response will reflect updates made by the candidate after applying.Candidate.documentIdcan be used as a stable identifier for the candidate across multiple applications.
- The job ad that the candidate is applying to via the
CandidateProfile.associatedPositionProfilefield.You can use this to associate the candidate application with a SEEK job ad and hirer. - The position opening that the candidate is applying to via the
CandidateProfile.associatedPositionOpeningsfield.You’ll likely be better off linking through the position profile; this field is supported to align with HR-JSON.
The candidate profile itself contains:
- Structured details of the candidate’s employment history, education, and more.These fields are taken as a snapshot of the candidate’s SEEK profile when they apply through SEEK’s website or mobile app.
- Links to attachments such as the candidate’s resume and cover letter.
- The candidate’s responses to the job’s screening questions via a
seekQuestionnaireSubmissionfield. This will only be present if a questionnaire was provided when posting the job ad.
For detailed information on all available fields, refer to the
CandidateProfile schema definition .
Only a name and email address are required to create a SEEK candidate account;
all other fields in a candidate’s profile are optional.Use the GraphQL
candidateProfile query to retrieve candidate profiles.
You should combine this with the query you use to retrieve attachments and questionnaire submissions.QueryVariablesResult
CopyGraphQL Explorer
query ($id: String!) {
candidateProfile(id: $id) {
profileId {
value
}
createDateTime
candidate {
person {
name {
given
family
}
communication {
phone {
formattedNumber
}
email {
address
}
}
}
}
associatedPositionProfile {
seekHirerJobReference
positionOrganizations {
id {
value
}
name
}
positionUri
}
employment {
organization {
name
}
positionHistories {
start
end
title
}
}
education {
institution {
name
}
educationDegrees {
name
degreeGrantedStatus
date
}
descriptions
}
certifications {
name
issued
effectiveTimePeriod {
validTo
}
issuingAuthority {
name
}
descriptions
}
qualifications {
competencyName
}
}
}