TalentLyft API
HomeHelpContact UsRequest a Demo
Search…
Getting started
Requests
Responses
Pagination
Authorization
Customers Private API
Jobs
Candidates
Events
Account Members
Employees
Departments
Webhooks & Notifications
Customers Public API
Jobs
Locations
Departments
Partners API
Sourcing & Employee referrals
Job Boards
Assessments
Video Interviews
Background checks
HRIS & Onboarding
Powered By GitBook
Candidates
get
https://api.talentlyft.com
/v2/candidates
Get candidates
get
https://api.talentlyft.com
/v2/candidates/:id
Get candidate details
post
https://api.talentlyft.com
/v2/candidates
Create candidate

Candidate's avatar

Candidate’s avatar is a object.
Parameter
Required
Type
Description
FileName
no
string
Name of the image file with extension (resume.pdf, cv.docx)
Content
yes*
string
Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.
Url
yes*
string
Url of the image (if you are providing the url, you do not need to provide the content).
ContentType
no
string
MIME type, one of the following types: image/jpeg, image/png

Candidate's resume

Candidate’s resume is a object.
Parameter
Required
Type
Description
FileName
yes
string
Name of the file with extension (resume.pdf, cv.docx)
Content
yes*
string
Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.
Url
yes*
string
Url of the resume (if you are providing the url, you do not need to provide the content).
ContentType
no
string
MIME type, one of the following types: text/html, text/plain, application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document

Candidate's attachments

Candidate’s attachment is a list of entries. Each entry containing the following fields:
Parameter
Required
Type
Description
FileName
yes
string
Name of the file with extension (resume.pdf, cv.docx)
Content
yes*
string
Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.
Url
yes*
string
Url of the attachment (if you are providing the url, you do not need to provide the content).
ContentType
no
string
MIME type, one of the following types: text/html, text/plain, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, application/zip, application/x-7z-compressed

Candidate's location

Candidate’s location is a object.
Parameter
Required
Type
Description
CountryCode
yes
string
​ISO 3166-1​
City
yes*
string
City
ZipCode
yes*
string
Zip code
Address
no
string
Full address

Candidate's emails

Candidate’s email is a list of entries. Each entry containing the following fields:
Parameter
Required
Type
Description
Value
yes
string
The candidate's email
Type
no
string
One of the following types: email, email_personal or email_work.

Candidate's phones

Candidate’s phone is a list of entries. Each entry containing the following fields:
Parameter
Required
Type
Description
Value
yes
string
Name of the file with extension (resume.pdf, cv.docx)
Type
no
string
One of the following types: phone, phone_mobile, phone_home and phone_work

Candidate's social networks

Candidate’s social networks is a list of entries. Each entry containing the following fields:
Parameter
Required
Type
Description
Value
yes
string
The candidate's URL
Type
yes*
string
One of the following types: angellist, aboutme, crunchbase, behance, bitbucket, dribble, facebook, github, googleplus, linkedin, meetup, mixcloud, pinterest, quora, reddit, slideshare, soundcloud, stackexchange, stackoverflow, stumbleupon, tumblr, twitter, vimeo, vk, xing, youtube, instagram, klout, codeproject, other

Candidate's answers

Each talentlyft job can have a list of associated questions that can be retrieved from the /jobs/:id/form endpoint. For each question, an answer can be provided by adding the answers list in the posted data. For each question, add to the answers list the following attributes based on question’s type.

Questions types: text, textarea, address, date, url

Parameter
Required
Type
Description
Id
yes
int
The question key
Body
yes
string
One of the following types

Questions types: checkbox, radio, select, yesNo

Parameter
Required
Type
Description
Id
yes
int
The question key
Choices
yes
array
Choices ids, for single answer questions (radio, select, yesNo) provide only one selected choice

Questions types: file

Required
Type
Description
​
Id
yes
string
The question key
File.FileName
yes
string
Name of the file with extension (resume.pdf, cv.docx)
File.Content
yes*
string
Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.
File.Url
yes*
string
Url of the answer (if you are providing the url, you do not need to provide the content).
File.ContentType
no
string
MIME type, one of the following types: text/html, text/plain, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, application/zip, application/x-7z-compressed

Candidate's projects

Candidate’s project is a list of entries. Each entry containing the following fields:
Parameter
Required
Type
Description
ProjectName
yes
string
​
ProjectUrl
no
string
​
Description
no
string
​
From
no
date
​ISO 8601​
To
no
date
​ISO 8601​

Candidate's experiences

Candidate’s experience is a list of entries. Each entry containing the following fields:
Parameter
Required
Type
Description
Title
yes
string
​
Company
yes
string
​
Description
no
string
​
From
no
date
​ISO 8601​
To
no
date
​ISO 8601​

Candidate's education

Candidate’s education is a list of entries. Each entry containing the following fields:
Parameter
Required
Type
Description
Institution
yes
string
​
Degree
yes
string
​
Description
no
string
​
From
no
date
​ISO 8601​
To
no
date
​ISO 8601​

Candidate's languages

Candidate’s language is a list of entries. Each entry containing the following fields:
Parameter
Required
Type
Description
LanguageIso
yes
string
​ISO 3166-1 alpha-2 code
LanguageProficiency
yes
string
One of the following types: elementary, limited_working, professional_working, full_professional and native

Candidate's source

Parameter
Required
Type
Description
SourceType
no
string
One of the following types:
  • JobBoard - job board
  • Recruiter - external recruiter
  • Referral - employee referral
  • CareersPage - organic, direct traffic, referral url, JsWidget and other
  • Sourced - sourced or manually uploaded
  • Social - social network shares or FacebookTab App
  • Campaigns - email or sms campaigns
  • Paid - paid search, paid social...
  • CandidateRediscovery - TalentLyft smart assistant
SourceBy
no
string
If SourceType is one of the following types: Recruiter orSourcedSourcBy must be Id of the team members. If SourceTypeis Referral SourceBy must be Employee uid
SourceFrom
no
string
Job board name: Indeed, ZipRecruiter or social media: facebook, twitter.

Compliance

Parameter
Required
Type
Description
Gdpr.RetentionConsent
no
boolean
​
Gdpr.PrivacyPolicyConsent
no
boolean
​
Gdpr.ShareConsent
no
boolean
​

​

​
​
​
Customers Private API - Previous
Jobs
Next - Customers Private API
Events
Last modified 1yr ago
Copy link
On this page
get
Get candidates
get
Get candidate details
post
Create candidate
Candidate's avatar
Candidate's resume
Candidate's attachments
Candidate's location
Candidate's emails
Candidate's phones
Candidate's social networks
Candidate's answers
Candidate's projects
Candidate's experiences
Candidate's education
Candidate's languages
Candidate's source
Compliance