curl --location --request GET 'https://api.hirempire.com/v1/candidates' \
--header 'Authorization: Bearer sk-••••••••••••'
curl --location --request GET 'https://api.hirempire.com/v1/candidates?type=applicant' \
--header 'Authorization: Bearer sk-••••••••••••'
const response = await fetch('https://api.hirempire.com/v1/candidates', {
method: 'GET',
headers: { 'Authorization': 'Bearer sk-••••••••••••' }
});
const data = await response.json();
console.log(data);
import requests
url = "https://api.hirempire.com/v1/candidates"
headers = { "Authorization": "Bearer sk-••••••••••••" }
# Optional: filter by type
# params = { "type": "applicant" }
response = requests.get(url, headers=headers)
print(response.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.hirempire.com/v1/candidates',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer sk-••••••••••••'
),
));
$response = curl_exec($curl);
curl_close($curl);
print_r(json_decode($response, true));
?>
{
"success": true,
"total_candidates": 2,
"candidates": [
{
"id": "8fc4ea3c-ecc4-4a92-96fd-a14436a79a1b",
"applied_at": "2026-06-18T12:30:00.000Z",
"type": "applicant",
"name": "John Doe",
"email": "john.doe@example.com",
"phone_number": "+15551234567",
"linkedin_url": "https://www.linkedin.com/in/johndoe",
"cv_url": "https://example.com/cv/johndoe.pdf",
"photo_url": "https://example.com/photos/johndoe.jpg",
"source": "LinkedIn",
"status": "shortlisted",
"nationality": "United States",
"location": "San Francisco",
"experience_years": 6,
"salary_expectation": 120000,
"job_id": "f3a2c1d4-1111-4222-9333-444455556666",
"job_title": "Senior Software Engineer",
"ai_summary": "Strong full-stack background, 6 yrs React + Node.",
"ai_score": 85,
"ai_decision": "Shortlist",
"ai_match_percentage": 92
},
{
"id": "0c8b5e54-e053-40b2-8c9c-b45ec90acf8a",
"applied_at": "2026-06-17T09:15:00.000Z",
"type": "prospect",
"name": "Sarah Smith",
"email": "sarah.smith@example.com",
"phone_number": "+447987654321",
"linkedin_url": "https://www.linkedin.com/in/sarahsmith",
"cv_url": null,
"photo_url": null,
"source": "Sourcing",
"status": "qualified",
"nationality": "United Kingdom",
"location": "London",
"experience_years": 8,
"salary_expectation": null,
"job_id": null,
"job_title": null,
"ai_summary": null,
"ai_score": null,
"ai_decision": null,
"ai_match_percentage": null
}
]
}
Candidates
Get all candidates
Retrieve all candidates from your Hirempire workspace
GET
/
v1
/
candidates
curl --location --request GET 'https://api.hirempire.com/v1/candidates' \
--header 'Authorization: Bearer sk-••••••••••••'
curl --location --request GET 'https://api.hirempire.com/v1/candidates?type=applicant' \
--header 'Authorization: Bearer sk-••••••••••••'
const response = await fetch('https://api.hirempire.com/v1/candidates', {
method: 'GET',
headers: { 'Authorization': 'Bearer sk-••••••••••••' }
});
const data = await response.json();
console.log(data);
import requests
url = "https://api.hirempire.com/v1/candidates"
headers = { "Authorization": "Bearer sk-••••••••••••" }
# Optional: filter by type
# params = { "type": "applicant" }
response = requests.get(url, headers=headers)
print(response.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.hirempire.com/v1/candidates',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer sk-••••••••••••'
),
));
$response = curl_exec($curl);
curl_close($curl);
print_r(json_decode($response, true));
?>
{
"success": true,
"total_candidates": 2,
"candidates": [
{
"id": "8fc4ea3c-ecc4-4a92-96fd-a14436a79a1b",
"applied_at": "2026-06-18T12:30:00.000Z",
"type": "applicant",
"name": "John Doe",
"email": "john.doe@example.com",
"phone_number": "+15551234567",
"linkedin_url": "https://www.linkedin.com/in/johndoe",
"cv_url": "https://example.com/cv/johndoe.pdf",
"photo_url": "https://example.com/photos/johndoe.jpg",
"source": "LinkedIn",
"status": "shortlisted",
"nationality": "United States",
"location": "San Francisco",
"experience_years": 6,
"salary_expectation": 120000,
"job_id": "f3a2c1d4-1111-4222-9333-444455556666",
"job_title": "Senior Software Engineer",
"ai_summary": "Strong full-stack background, 6 yrs React + Node.",
"ai_score": 85,
"ai_decision": "Shortlist",
"ai_match_percentage": 92
},
{
"id": "0c8b5e54-e053-40b2-8c9c-b45ec90acf8a",
"applied_at": "2026-06-17T09:15:00.000Z",
"type": "prospect",
"name": "Sarah Smith",
"email": "sarah.smith@example.com",
"phone_number": "+447987654321",
"linkedin_url": "https://www.linkedin.com/in/sarahsmith",
"cv_url": null,
"photo_url": null,
"source": "Sourcing",
"status": "qualified",
"nationality": "United Kingdom",
"location": "London",
"experience_years": 8,
"salary_expectation": null,
"job_id": null,
"job_title": null,
"ai_summary": null,
"ai_score": null,
"ai_decision": null,
"ai_match_percentage": null
}
]
}
Query Parameters
string
Filter the result by candidate type. One of:
applicant prospect upload. If omitted, all three types are returned.Authentication
string
required
Bearer authentication header of the form
Bearer <token>, where <token> is your API token.curl --location --request GET 'https://api.hirempire.com/v1/candidates' \
--header 'Authorization: Bearer sk-••••••••••••'
curl --location --request GET 'https://api.hirempire.com/v1/candidates?type=applicant' \
--header 'Authorization: Bearer sk-••••••••••••'
const response = await fetch('https://api.hirempire.com/v1/candidates', {
method: 'GET',
headers: { 'Authorization': 'Bearer sk-••••••••••••' }
});
const data = await response.json();
console.log(data);
import requests
url = "https://api.hirempire.com/v1/candidates"
headers = { "Authorization": "Bearer sk-••••••••••••" }
# Optional: filter by type
# params = { "type": "applicant" }
response = requests.get(url, headers=headers)
print(response.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.hirempire.com/v1/candidates',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer sk-••••••••••••'
),
));
$response = curl_exec($curl);
curl_close($curl);
print_r(json_decode($response, true));
?>
Response
boolean
Indicates if the request was successful
integer
Total number of candidates returned
array
Array of candidate objects
Show Candidate object properties
Show Candidate object properties
string
Unique identifier for the candidate
string
ISO 8601 timestamp when the candidate entered the workspace
string
Candidate sub-type. One of:
applicant (applied to a job), prospect (sourced), upload (manually uploaded)string
Full name of the candidate
string
Email address
string
Phone number
string
LinkedIn profile URL
string
URL to the candidate’s CV/resume
string
URL to the candidate’s photo
string
Source where the candidate came from (e.g.
LinkedIn, Referral, Indeed)string
Current pipeline status. One of:
applied screening phone_screen interview technical offer hired rejected withdrawn on_hold shortlisted qualified uploadedstring
Candidate nationality
string
Candidate location (city)
number
Years of professional experience
number
Salary expectation in the workspace’s default currency
string
ID of the job the candidate is associated with (null for unassigned)
string
Title of the associated job (null for unassigned)
string
AI-generated summary of the candidate
number
AI score from 0–100
string
AI hiring recommendation (e.g.
Shortlist, Review, Reject)number
Job-to-candidate match percentage
{
"success": true,
"total_candidates": 2,
"candidates": [
{
"id": "8fc4ea3c-ecc4-4a92-96fd-a14436a79a1b",
"applied_at": "2026-06-18T12:30:00.000Z",
"type": "applicant",
"name": "John Doe",
"email": "john.doe@example.com",
"phone_number": "+15551234567",
"linkedin_url": "https://www.linkedin.com/in/johndoe",
"cv_url": "https://example.com/cv/johndoe.pdf",
"photo_url": "https://example.com/photos/johndoe.jpg",
"source": "LinkedIn",
"status": "shortlisted",
"nationality": "United States",
"location": "San Francisco",
"experience_years": 6,
"salary_expectation": 120000,
"job_id": "f3a2c1d4-1111-4222-9333-444455556666",
"job_title": "Senior Software Engineer",
"ai_summary": "Strong full-stack background, 6 yrs React + Node.",
"ai_score": 85,
"ai_decision": "Shortlist",
"ai_match_percentage": 92
},
{
"id": "0c8b5e54-e053-40b2-8c9c-b45ec90acf8a",
"applied_at": "2026-06-17T09:15:00.000Z",
"type": "prospect",
"name": "Sarah Smith",
"email": "sarah.smith@example.com",
"phone_number": "+447987654321",
"linkedin_url": "https://www.linkedin.com/in/sarahsmith",
"cv_url": null,
"photo_url": null,
"source": "Sourcing",
"status": "qualified",
"nationality": "United Kingdom",
"location": "London",
"experience_years": 8,
"salary_expectation": null,
"job_id": null,
"job_title": null,
"ai_summary": null,
"ai_score": null,
"ai_decision": null,
"ai_match_percentage": null
}
]
}
Error Responses
400 Bad Request
{
"success": false,
"error": "Only 'type' query parameter is allowed."
}
{
"success": false,
"error": "type must be one of: applicant, prospect, upload"
}
401 Unauthorized
{
"success": false,
"error": "Invalid token"
}
{
"success": false,
"error": "Token is expired"
}
Was this page helpful?
⌘I