---
title: "Get list of migration jobs"
method: GET
path: "/migration-jobs"
tags: ["private"]
---

# Get list of migration jobs

`GET /migration-jobs`

## Request

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

Lists all migration jobs in a paginated format.

## Query parameters

- `limit` integer
- `offset` integer
- `state` 'submitted' | 'in_review' | 'approved' | 'published' | 'completed' | 'rejected' | 'cancelled' | 'migrating' | 'publishing' | 'pending_post_publish' | 'post_publishing' | 'reverting' | 'failed_post_publish' | 'failed_publish' | 'failed_migration' | 'failed_reversion'
- `sort` 'job_number:asc' | 'job_number:desc' | 'label:asc' | 'label:desc'

## Response `200`

Successful response

- MigrationJobList
  - `count` integer: How many jobs are present in the response
  - `limit` integer: Max number of jobs we are returning with this response
  - `offset` integer: The number of documents into the full list this response started at
  - `total_count` integer: How many jobs are available in total
  - `items` MigrationJob[]: Array containing results.
    - `job_number` integer
    - `last_updated` string, date-time
    - `label` string: The title of the source dataset, automatically populated during job creation
    - `links` object
      - `events` object: A link to all the events for the migration job
        - `href` string: A fully qualified URL to the migration job's events API response
      - `self` object: A link to the individual migration job
        - `href` string: A fully qualified URL to the migration job API response
        - `job_number` integer
      - `tasks` object: A link to all the tasks for the migration job
        - `href` string: A fully qualified URL to the migration job's tasks API response
    - `config` MigrationJobConfig
      - `collection_id` string
      - `source_id` string
      - `target_id` string
      - `type` 'static_dataset'
    - `state` 'submitted' | 'in_review' | 'approved' | 'published' | 'completed' | 'rejected' | 'cancelled' | 'migrating' | 'publishing' | 'pending_post_publish' | 'post_publishing' | 'reverting' | 'failed_post_publish' | 'failed_publish' | 'failed_migration' | 'failed_reversion'
    - `type` 'static_dataset'
  - `states` StateSummary[]: An array of summaries of the states found in the full result set.
    - `id` string: A computer usable key for this state
    - `label` string: A human readable label for this state
    - `count` integer: The number of results with this state within the full set of results.

## Other responses

- `400`: Invalid request parameter(s)
- `401`: Request is not authenticated
- `403`: Request is not authorised
- `500`: Generic error response

---

[API](https://skmtc.dev/office-of-national-statistics/apis/dis-migration-service.md) - [All operations](https://skmtc.dev/office-of-national-statistics/apis/dis-migration-service/llms.txt) - [OpenAPI document](https://skmtc.dev/office-of-national-statistics/apis/dis-migration-service/revisions/5dddd1472e20?raw)