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

# List jobs

`GET /jobs`

## Request

- Base URL: `https://localhost/index.php/api`
- URL: `https://localhost/index.php/api/jobs`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/worldbank/apis/metadata-editor-jobs-api/docs/jobs/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of background jobs. Returns basic job information. Use GET /jobs/{uuid} for full details including payload and result.

## Query parameters

- `status` 'pending' | 'held' | 'processing' | 'completed' | 'failed'
- `job_type` 'generate_pdf' | 'generate_microdata_resource' | 'import_microdata' | 'import_indicator_data' | 'publish_project' | 'hello_world': Registered background job type identifier
- `user_id` integer
- `limit` integer
- `offset` integer

## Response `200`

successful operation

- JobListResponse
  - `status` string
  - `total` integer: Total number of jobs in the response
  - `found` integer: Number of jobs found
  - `limit` integer: Limit used for pagination
  - `offset` integer: Offset used for pagination
  - `jobs` JobBasic[]
    - `uuid` string
    - `job_type` 'generate_pdf' | 'generate_microdata_resource' | 'import_microdata' | 'import_indicator_data' | 'publish_project' | 'hello_world': Registered background job type identifier
    - `status` 'pending' | 'held' | 'processing' | 'completed' | 'failed'
    - `priority` integer
    - `user_id` integer
    - `attempts` integer
    - `max_attempts` integer
    - `created_at` string, date-time
    - `started_at` string, date-time
    - `completed_at` string, date-time
    - `worker_id` string
    - `job_status_link` string, uri: URL to get full job details

## Other responses

- `400`: Bad request

## Changes

- **2026-06-06** `7f334b22fc50`: 1 breaking, 6 warning, 6 info
  - the `query` request parameter `job_type` was restricted to a list of enum values
  - added the new `generate_microdata_resource` enum value to the `jobs/items/job_type` response property for the response status `200`
  - added the new `generate_pdf` enum value to the `jobs/items/job_type` response property for the response status `200`
  - added the new `hello_world` enum value to the `jobs/items/job_type` response property for the response status `200`
  - …9 more
- **2026-05-24** `1ff58dcd71a4`: 1 warning, 1 info
  - added the new `held` enum value to the `jobs/items/status` response property for the response status `200`
  - added the new enum value `held` to the `query` request parameter `status`

[Operation history](https://skmtc.dev/worldbank/apis/metadata-editor-jobs-api/changes/jobs/get.md)

---

[API](https://skmtc.dev/worldbank/apis/metadata-editor-jobs-api.md) - [All operations](https://skmtc.dev/worldbank/apis/metadata-editor-jobs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/worldbank/apis/metadata-editor-jobs-api/revisions/755536b6492e?raw)