---
title: "Get Jobs"
method: GET
path: "/jobs/"
tags: ["jobs"]
---

# Get Jobs

`GET /jobs/`

Get jobs using RQ Groups-based querying.

Maps document IDs to RQ Groups for efficient job status retrieval.
For reference-level queries, searches over documents linked to the reference.

## Query parameters

- `document_id` string, uuid, nullable — Filter by document ID
- `reference` string, nullable — Filter by document reference
- `group_id` string, nullable — Filter by RQ Group ID

## Response `200`

Successful Response

- WorkflowJobResult[]
  - `id` string, required — Job ID
  - `status` 'created' | 'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled', required — The Status of Job within its lifecycle at any given time.
  - `document_id` string, uuid, nullable — Document ID associated with the job
  - `reference` string, nullable — Document reference for tracking
  - `workspace_id` string, uuid, nullable — Workspace ID
  - `workflow_step` string, nullable — Current workflow step
  - `progress` number, nullable — Job progress (0.0-1.0)
  - `error` string, nullable — Error message if job failed
  - `result` object, nullable — Job result data
  - `meta` object, nullable — Additional job metadata
  - `started_at` string, date-time, nullable — When job was started
  - `completed_at` string, date-time, nullable — When job was completed
  - `group_id` string, nullable — RQ Group ID for the workflow
  - `group_status` string, nullable — Status of the entire RQ Group
  - `group_progress` number, nullable — Overall progress of the group (0.0-1.0)
  - `total_jobs` integer, nullable — Total number of jobs in the group
  - `completed_jobs` integer, nullable — Number of completed jobs in the group
  - `failed_jobs` integer, nullable — Number of failed jobs in the group
  - `running_jobs` integer, nullable — Number of running jobs in the group

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Unprocessable Content
- `500` — Internal Server Error

---

[API](https://skmtc.net/hf/apis/extralit-v1.md) · [All operations](https://skmtc.net/hf/apis/extralit-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hf/extralit-v1/revisions/e9da3a893a88/schema)