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

# List jobs

`GET /v2/jobs`

Lists jobs for the account. Jobs are background processes, such as replacing the filterable metadata attributes.

## Query parameters

- `corpus_key` CorpusKey[]
- `after` string, date-time
- `state` JobState[]
- `limit` integer
- `page_key` string

## Headers

- `Request-Timeout` integer
- `Request-Timeout-Millis` integer

## Response `200`

List of jobs.

- ListJobsResponse — Response containing a list of background jobs and their current states.
  - `jobs` Job[] — An array of jobs.
    - `id` string, required — The ID of the job.
    - `type` 'rebuild_vector_index' | 'replace_filter_attributes' | 'bulk_delete_documents' | 'bulk_update_document_metadata' | 'unknown' — The type of job.
    - `corpus_keys` CorpusKey[] — The corpora that this job belongs to. Some jobs do not belong to any corpus.
    - `state` 'unknown' | 'queued' | 'started' | 'completed' | 'failed' | 'failed_will_retry' | 'aborted' — The state of a background job.
    - `created_at` string, date-time — When the job was created.
    - `started_at` string, date-time — When the job was started.
    - `completed_at` string, date-time — When the job was completed.
    - `created_by_username` string — The username of the user who created the job. This property can be absent, for example when the platform created the job.
    - `comment` string — A human-readable explanation of the job's current status. The format and content depend on the job type. On failure, this property contains the error message. This property can be absent.
  - `metadata` ListMetadata — The standard metadata in the response of a list operation.
    - `page_key` string — The page key for the next page of results. Pass it as a query parameter to request the next page.

## Other responses

- `403` — Permissions do not allow listing jobs.

---

[API](https://skmtc.net/vectara/apis/vectara-rest-api-v2.md) · [All operations](https://skmtc.net/vectara/apis/vectara-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vectara/vectara-rest-api-v2/revisions/fca567a46b3a/schema)