v1

latestOpenAPI 3.1.02026-08-0456127224.3 KB

Candidates

Async ingest a single candidate

Queue a candidate for async processing through the interviewer's workflow. Returns an ingestion ID to track the job.

post/api/v2/postings/{posting_id}/candidates/async

Path parameters

posting_idstring required

Headers

X-API-KEYstring nullable

Authorizationstring nullable

X-Workspace-Idstring nullable

Request body

namestring required

Candidate full name

emailstring required

Candidate email address

phone_numberstring nullable

Candidate phone number (E.164 format)

metadataobject nullable

Set of key-value pairs for storing additional information on the candidate. Up to 50 keys, each key max 40 chars, each value max 500 chars.

dataobject nullable

Additional candidate data

Example request

{
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "phone_number": "+12065551234",
  "metadata": {
    "ats_stage": "phone_screen",
    "external_id": "candidate_xyz"
  }
}

Response

Successful Response

metaobject nullable

Optional metadata. Shape varies by endpoint.

Example response

{
  "data": {
    "ingestion_id": "intake_abc123",
    "status": "queued"
  }
}