v1

latestOpenAPI 3.1.02026-08-0456127224.3 KB
ATS

Resolve a candidate in the ATS

Search the connected ATS for a candidate by email or ATS candidate ID. Returns matching candidates so the caller can decide whether to push an existing record or create a new one. Only Bullhorn and Avionte are currently supported.

post/api/v2/ats/candidates/resolve

Headers

X-API-KEYstring nullable
Authorizationstring nullable
X-Workspace-Idstring nullable

Request body

ats_namestring required

ATS provider name (e.g. 'bullhorn').

emailstring nullable

Candidate email to search by.

ats_candidate_idstring nullable

ATS-native candidate ID to search by.

limitinteger nullable

Max matches to return.

Response

Successful Response

metaobject nullable

Optional metadata. Shape varies by endpoint.