Skip to content

Get top candidates

GET
/api/v1/hiring/{process_id}/candidates

Retrieve the top-ranked candidates for a hiring process.

Authorizations

Parameters

Path Parameters

process_id
required
string format: uuid

Query Parameters

limit
integer
default: 5

Responses

200

Successful Response

Typed envelope for GET /{process_id}/candidates.

object
data
required

Response body listing the top-ranked candidates for a hiring process.

Attributes: candidates: Ordered list of screening results, best candidates first.

object
candidates
required

Top candidates sorted by recommendation tier then fit score

Array<object>

Response body for a candidate screening result.

Attributes: candidate_id: UUID of the screened candidate. fit_score: Overall fit score from 0 to 100. recommendation: Overall recommendation (recommend, maybe, pass). strengths: Key strengths identified for this role. concerns: Areas of concern about the candidate. reasoning: Detailed reasoning behind the recommendation.

object
candidate_id
required

ID of the screened candidate

string format: uuid
concerns

Areas of concern about this candidate

Array<string>
fit_score
required

Overall fit score from 0 to 100

integer
<= 100
reasoning
required

Detailed reasoning behind the recommendation

string
recommendation
required

Overall recommendation: recommend, maybe, or pass

string
strengths
required

Candidate’s key strengths for this role

Array<string>
meta
required

Standard metadata attached to every API response.

object
request_id
required

Unique request identifier

string
timestamp
required

Server timestamp of the response

string format: date-time

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string