.png?fit=max&auto=format&n=lKy84_BssSCy2hcz&q=85&s=ac7c949427cc2893306f6036415f087e)
List candidates for a job
curl --request GET \
--url https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates \
--header 'Authorization: Bearer <token>'import requests
url = "https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"candidates": [
{
"jobCandidateId": 123,
"jobId": 12345,
"stageId": 5,
"status": "PENDING",
"createdAt": "2024-01-20T10:00:00Z",
"updatedAt": "2024-01-21T14:30:00Z",
"profileMatchScore": 85,
"criteriaMatches": {
"skills": 90,
"experience": 80,
"education": 75
},
"recommendToRecruitingFirm": true,
"aiSummary": "Strong candidate with relevant experience in React and Node.js...",
"candidate_details": {
"id": 456,
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"phone": "+1234567890",
"currentJobTitle": "Senior Software Engineer",
"currentCompany": "Tech Corp",
"city": "San Francisco",
"country": "United States",
"skills": [
"JavaScript",
"React",
"Node.js"
],
"resume": "https://storage.example.com/resumes/john-doe.pdf",
"majors": [
"Computer Science"
],
"summary": "Experienced software engineer...",
"languages": [
"English"
],
"educations": [
{
"degree": "Bachelor's",
"field": "Computer Science",
"institution": "University"
}
],
"workExperiences": [
{
"title": "Software Engineer",
"company": "Tech Corp",
"duration": "2 years"
}
],
"projectExperiences": [],
"certifications": [],
"githubUrl": "https://github.com/johndoe",
"linkedin": "https://linkedin.com/in/johndoe"
},
"customFields": {
"13": {
"label": "Preferred Communication Channel",
"value": "Email",
"parentSection": "Personal Details"
}
}
}
],
"pagination": {
"page": 1,
"perPage": 20,
"totalCandidates": 45,
"totalPages": 3
}
}
}Job Candidates
List candidates for a job
Retrieve all candidates associated with a specific job, with pagination, filtering, and sorting options.
resumeScoreMin/resumeScoreMaxfilter on the AIprofileMatchScorefield of each job candidate, despite the “resume” naming.excludeRejected=truefilters out rejected candidates; by default rejected candidates are included.stageIdrestricts results to a single pipeline stage.- Results are sorted by
createdAtdescending by default.
GET
/
job-candidates
/
job
/
{jobId}
/
candidates
List candidates for a job
curl --request GET \
--url https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates \
--header 'Authorization: Bearer <token>'import requests
url = "https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://partner-api.taptalent.io/v1/partner/job-candidates/job/{jobId}/candidates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"candidates": [
{
"jobCandidateId": 123,
"jobId": 12345,
"stageId": 5,
"status": "PENDING",
"createdAt": "2024-01-20T10:00:00Z",
"updatedAt": "2024-01-21T14:30:00Z",
"profileMatchScore": 85,
"criteriaMatches": {
"skills": 90,
"experience": 80,
"education": 75
},
"recommendToRecruitingFirm": true,
"aiSummary": "Strong candidate with relevant experience in React and Node.js...",
"candidate_details": {
"id": 456,
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"phone": "+1234567890",
"currentJobTitle": "Senior Software Engineer",
"currentCompany": "Tech Corp",
"city": "San Francisco",
"country": "United States",
"skills": [
"JavaScript",
"React",
"Node.js"
],
"resume": "https://storage.example.com/resumes/john-doe.pdf",
"majors": [
"Computer Science"
],
"summary": "Experienced software engineer...",
"languages": [
"English"
],
"educations": [
{
"degree": "Bachelor's",
"field": "Computer Science",
"institution": "University"
}
],
"workExperiences": [
{
"title": "Software Engineer",
"company": "Tech Corp",
"duration": "2 years"
}
],
"projectExperiences": [],
"certifications": [],
"githubUrl": "https://github.com/johndoe",
"linkedin": "https://linkedin.com/in/johndoe"
},
"customFields": {
"13": {
"label": "Preferred Communication Channel",
"value": "Email",
"parentSection": "Personal Details"
}
}
}
],
"pagination": {
"page": 1,
"perPage": 20,
"totalCandidates": 45,
"totalPages": 3
}
}
}Authorizations
Company-scoped API key. Production keys are prefixed sk_live_,
sandbox keys sk_test_, each followed by 22 base62 characters
(pattern ^sk_(live|test)_[0-9A-Za-z]{22}$). Generate keys in the
TapTalent dashboard under Account Settings → Developers → API Key
Management; a key is shown once at generation and old keys are
invalidated immediately on regeneration.
Path Parameters
The unique identifier of the job.
Query Parameters
Page number (default: 1).
Required range:
x >= 1Items per page. Must be one of: 10, 20, 40, 80, 100 (default: 20).
Available options:
10, 20, 40, 80, 100 Filter candidates by pipeline stage ID.
Minimum resume/AI match score (0-100). Filters candidates with a
score greater than or equal to this value. Despite the name, this
filters on the profileMatchScore field.
Required range:
0 <= x <= 100Maximum resume/AI match score (0-100). Filters candidates with a
score less than or equal to this value. Despite the name, this
filters on the profileMatchScore field.
Required range:
0 <= x <= 100Column to sort by. Default: createdAt.
Available options:
createdAt, firstName Sort order. Default: DESC.
Available options:
ASC, DESC Exclude rejected candidates from results. Set to true to filter
out rejected candidates. Default: false.
Was this page helpful?