Fetching data...
Developer API Reference
Build powerful integrations with our platform APIs.
Developer API Reference
Build powerful integrations with our platform APIs.
Public-api-inbound-
Dynamic API reference synchronized with our latest backend endpoints.
GET
Get candidate details
/api/v1/candidates/{id}Returns the full profile for a specific candidate, including their associated job.
Parameters
idRequiredstringThe candidate UUID
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/candidates/{id}" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"id": "can-123e4567-e89b-12d3-a456-426614174000",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"status": "active",
"job_id": "job-123e4567-e89b-12d3-a456-426614174000",
"job_searches": {
"id": "job-123e4567-e89b-12d3-a456-426614174000",
"title": "Frontend Developer",
"status": "active"
},
"external_id": "string",
"metadata": {}
}PATCH
Update candidate profile
/api/v1/candidates/{id}Updates fields for an existing candidate.
Parameters
idRequiredstringfirst_namestringlast_namestringemailstringstatusstringexternal_idstringmetadataobjectExample Request
bashcurl -X PATCH "https://your-tenant.peoplelensai.com/api/v1/candidates/{id}" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{"first_name":"string","last_name":"string","email":"string","status":"active","external_id":"string","metadata":{}}'Example Response
json{
"id": "can-123e4567-e89b-12d3-a456-426614174000",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"status": "hired"
}DELETE
Delete a candidate
/api/v1/candidates/{id}Permanently removes a candidate profile and their associations.
Parameters
idRequiredstringExample Request
bashcurl -X DELETE "https://your-tenant.peoplelensai.com/api/v1/candidates/{id}" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" GET
Check candidate interview status
/api/v1/candidates/{id}/statusReturns the status of the most recent interview for the candidate. Useful for polling interview completion.
Parameters
idRequiredstringThe candidate UUID
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/candidates/{id}/status" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"candidate_id": "can-123e4567-e89b-12d3-a456-426614174000",
"candidate_name": "Jane Doe",
"status": "in_progress",
"latest_interview": {
"plan_id": "plan-123",
"plan_status": "active",
"total_steps": 3,
"completed_steps": 1,
"created_at": "2026-02-25T08:00:00Z",
"updated_at": "2026-02-25T09:00:00Z"
}
}