Skip to main content

​
List Retrieval Jobs

Returns all retrieval jobs, ordered by createdAt descending. Filter by dock or status using query parameters. 
GET /v1/retrieval/jobs

​
Query Parameters

ParameterTypeRequiredDescription
dockIdstringRequiredFilter jobs by dock ID
statusstringOptionalFilter by status: PENDING, PROCESSING, COMPLETED, or FAILED
limitintegerOptionalMaximum number of results to return (default: 100)
offsetintegerOptionalNumber of results to skip for pagination (default: 0)

​
Example Request

curl "https://api.docyard.io/v1/retrieval/jobs?dockId=dock_01HQ3K...&status=COMPLETED&limit=10" \
  -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"
  },
  {
    "id": "ret_01HQ4B...",
    "dockId": "dock_01HQ3K...",
    "status": "COMPLETED",
    "totalCount": 5,
    "readyCount": 4,
    "errorCount": 1,
    "createdAt": "2025-01-21T09:30:00.000Z"
  }
]

​
Error Handling

StatusCondition
400dockId query parameter is missing
401Missing or invalid API key
404Dock not found