---
title: "Get a list of all jobs"
method: GET
path: "/jobs"
tags: ["Import API"]
---

# Get a list of all jobs

`GET /jobs`

## Request

- Base URL: `/v1` (relative, and the document’s source URL is not known)
- URL: `/v1/jobs`
- Auth: API key in header `florence-token`

Lists can be filtered by the job state

## Query parameters

- `state` string[]
- `limit` integer
- `offset` integer

## Response `200`

A list of jobs has been returned

- JobList: A list of import jobs
  - `count` integer: The number of jobs returned
  - `items` Job[]
    - `id` string: A unique id for an import job
    - `recipe` string: The recipe to use when baking data. Below is a list of predefined recipes; * v4 - This will skip the data baking process.
    - `state` string: The state of the job, this can be; * created - The job has been created; * submitted - The job has been queue to be imported * completed - The job has been imported * error - The job was not imported (See the events in the instances)
    - `links` object
      - `instances` IDLink[]
        - `id` string: ID for the object
        - `href` string: The full URL for the object
    - `files` File[]: A list of all files to be used in the job
      - `alias_name` string: An alias name for the file
      - `url` string: The full S3 path including zone, and bucket
    - `last_updated` string, string: The time this job was last updated.
  - `limit` integer: The number of jobs requested
  - `offset` integer: The first row of jobs to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter
  - `total_count` integer: The total number of jobs

## Other responses

- `500`: Failed to process the request due to an internal error

---

[API](https://skmtc.dev/office-of-national-statistics/apis/import-api.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/import-api/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/import-api/revisions/8b1b6af71c8b?raw)