Get a candidate

GET

https://api.confirm.global/api/v1/candidates/:candidateId

GET

/api/v1/candidates/:candidateId

$ curl https://api.confirm.global/api/v1/candidates/candidateId \
>      -H "Authorization: Bearer <token>"

1 {
2   "candidate_id": "string",
3   "org_id": "string",
4   "first_name": "string",
5   "last_name": "string",
6   "email": "string",
7   "phone": "string",
8   "address_line1": "string",
9   "address_line2": "string",
10   "city": "string",
11   "state": "string",
12   "postal_code": "string",
13   "country": "string",
14   "source": "string",
15   "applications": [
16     {
17       "application_id": "string",
18       "org_id": "string",
19       "candidate_id": "string",
20       "job_id": "string",
21       "status": "applied",
22       "score": 1.1,
23       "applied_at": "2024-01-15T09:30:00Z",
24       "evaluation_status": "string",
25       "evaluation_sent_at": "2024-01-15T09:30:00Z",
26       "evaluation_completed_at": "2024-01-15T09:30:00Z",
27       "candidates": {
28         "candidate_id": "string",
29         "org_id": "string",
30         "first_name": "string",
31         "last_name": "string",
32         "email": "string",
33         "phone": "string",
34         "address_line1": "string",
35         "address_line2": "string",
36         "city": "string",
37         "state": "string",
38         "postal_code": "string",
39         "country": "string",
40         "source": "string",
41         "applications": [
42           null
43         ],
44         "created_at": "2024-01-15T09:30:00Z",
45         "updated_at": "2024-01-15T09:30:00Z"
46       },
47       "created_at": "2024-01-15T09:30:00Z",
48       "updated_at": "2024-01-15T09:30:00Z"
49     }
50   ],
51   "created_at": "2024-01-15T09:30:00Z",
52   "updated_at": "2024-01-15T09:30:00Z"
53 }

Returns full detail for a single candidate, including contact information, address, and their applications.

Authentication

AuthorizationBearer

Supabase-issued user JWT. Send as Authorization Bearer header. Dedicated API keys are planned for a future release.

Path parameters

candidateIdstringRequiredformat: "uuid"

Response

Candidate detail.

candidate_idstringOptionalformat: "uuid"

org_idstringOptionalformat: "uuid"

first_namestringOptional

last_namestringOptional

emailstring or nullOptionalformat: "email"

phonestring or nullOptional

address_line1string or nullOptional

address_line2string or nullOptional

citystring or nullOptional

statestring or nullOptional

postal_codestring or nullOptional

countrystring or nullOptional

sourcestring or nullOptional

Where the candidate came from (e.g. indeed, referral, manual).

applicationslist of objectsOptional

The candidate's applications, when included in the response.

created_atdatetimeOptional

updated_atdatetimeOptional

Errors

401

Unauthorized Error

404

Not Found Error