Manage candidate profiles and track their assessment journey.
The Candidates API provides access to candidate profiles, contact information, and assessment history. Use it to integrate candidate data with your ATS or recruiting workflow.
/candidates| Name | Type | Required | Description |
|---|---|---|---|
| status | string | Optional | Filter by status: invited, in_progress, completed |
| exam_id | string | Optional | Filter by exam ID |
| search | string | Optional | Search by name or email |
| limit | integer | Optional | Results per page (default: 20, max: 100) |
{
"data": [
{
"id": "cand_xyz789",
"email": "candidate@example.com",
"name": "Jane Smith",
"status": "completed",
"exams_taken": 2,
"avg_score": 87.5,
"created_at": "2024-02-10T14:20:00Z",
"last_activity": "2024-02-12T09:15:00Z"
}
],
"pagination": { "total": 156, "limit": 20, "has_more": true }
}/candidates/{candidate_id}{
"id": "cand_xyz789",
"email": "candidate@example.com",
"name": "Jane Smith",
"phone": "+1-555-0123",
"location": "San Francisco, CA",
"status": "completed",
"profile": {
"resume_url": "https://storage.talentscreens.org/resumes/...",
"linkedin_url": "https://linkedin.com/in/janesmith",
"years_experience": 5
},
"assessment_history": [
{
"exam_id": "exam_abc123",
"exam_title": "Full-Stack Developer",
"completed_at": "2024-02-12T09:15:00Z",
"score": 92
}
]
}/candidates| Name | Type | Required | Description |
|---|---|---|---|
| string | Required | Candidate email address | |
| name | string | Required | Full name |
| phone | string | Optional | Phone number |
| metadata | object | Optional | Custom metadata key-value pairs |
/candidates/{candidate_id}Candidate data is subject to data privacy regulations. Always handle personally identifiable information (PII) according to applicable laws and your privacy policy.
Was this article helpful?