Skip to main content

​
Retrieve a Job

Returns the full details and current status of a retrieval job. Use this endpoint to poll for job completion. 
GET /v1/retrieval/jobs/:jobId

​
Path Parameters

ParameterTypeDescription
jobIdstringThe retrieval job ID

​
Example Request

curl https://api.docyard.io/v1/retrieval/jobs/ret_01HQ4A... \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

​
Response

{
  "id": "ret_01HQ4A...",
  "dockId": "dock_01HQ3K...",
  "status": "COMPLETED",
  "totalCount": 24,
  "readyCount": 24,
  "errorCount": 0,
  "createdAt": "2025-01-22T12:00:00.000Z",
  "completedAt": "2025-01-22T12:00:45.000Z"
}

​
Error Handling

StatusCondition
401Missing or invalid API key
404Job not found
Job statuses progress through: PENDING -> PROCESSING -> COMPLETED (or FAILED). Once a job reaches COMPLETED, use Job Results to get the signed download URLs.