API Reference
Candidates
Search, read, and comment on candidates across your jobs.
Filtering
job_id— restrict to candidates in a single job.status—pending,processing,completed,failed. Mirrors the underlying scan status.
Comment timeline
Comments are append-only, attributed to the API token's actor user, and emit a candidate.commented webhook so external CRMs can stay in sync.
REST endpoints
GET
/v1/candidatesPaginated list, filterable by
candidates:readjob_id and status.GET
/v1/candidates/{id}Read a single candidate with full extracted profile.
candidates:readGET
/v1/candidates/{id}/commentsList internal team comments on a candidate.
candidates:readPOST
/v1/candidates/{id}/commentsPost a new internal comment.
candidates:write