v1

latestOpenAPI 3.1.02026-08-0456127224.3 KB
Candidates

Async bulk ingest candidates

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

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

Path parameters

posting_idstring required

Headers

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

Request body

Example request

{
  "data": [
    {
      "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"
  }
}