Skip to content
UltimateTeam.ai Docs

Get top candidates

GET
/api/v1/hiring/{process_id}/candidates
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/hiring/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/candidates?limit=5' \
  --header 'X-API-Key: <X-API-Key>'

Retrieve the top-ranked candidates for a hiring process.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
process_id
required
Process Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 5

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
TopCandidatesEnvelope

Typed envelope for GET /{process_id}/candidates.

object
data
required
TopCandidatesResponse

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

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

object
candidates
required
Candidates

Top candidates sorted by recommendation tier then fit score

Array<object>
ScreeningResultResponse

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
Candidate Id

ID of the screened candidate

string format: uuid
concerns
Concerns

Areas of concern about this candidate

Array<string>
fit_score
required
Fit Score

Overall fit score from 0 to 100

integer
<= 100
reasoning
required
Reasoning

Detailed reasoning behind the recommendation

string
recommendation
required
Recommendation

Overall recommendation: recommend, maybe, or pass

string
strengths
required
Strengths

Candidate’s key strengths for this role

Array<string>
meta
required
ResponseMeta

Standard metadata attached to every API response.

object
request_id
required
Request Id

Unique request identifier

string
timestamp
required
Timestamp

Server timestamp of the response

string format: date-time
Examplegenerated
{
  "data": {
    "candidates": [
      {
        "candidate_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "concerns": [
          "example"
        ],
        "fit_score": 1,
        "reasoning": "example",
        "recommendation": "example",
        "strengths": [
          "example"
        ]
      }
    ]
  },
  "meta": {
    "request_id": "example",
    "timestamp": "2026-04-15T12:00:00Z"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}