---
title: "List migrations"
method: GET
path: "/migrations"
tags: ["Migrations"]
---

# List migrations

`GET /migrations`

## Request

- Base URL: `https://app.vern.so/api/v1`
- URL: `https://app.vern.so/api/v1/migrations`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/vern-so/apis/vern-api/docs/migrations/get.ts> (a function with typed inputs; its response is checked against the schema)

Your account's migrations, newest first, including companies created in the Vern app. Keyset-paginated: pass `next_cursor` back as `cursor` until it is null. Look one up by its external ID with `?external_id=`. List items omit `status` (it costs several lookups each) — get a single migration for it. Archived migrations are left out unless `include_archived=true`.

## Query parameters

- `external_id` string
- `source` string
- `include_archived` boolean
- `limit` integer
- `cursor` string

## Response `200`

A page of migrations.

- object
  - `migrations` Migration[]
    - `id` string, uuid: The migration ID — pass it to every later call.
    - `name` string
    - `external_id` string, nullable: Your own identifier for this customer.
    - `source` string, nullable
    - `status` 'awaiting_files' | 'ready' | 'awaiting_approval' | 'completed': Omitted from `GET /migrations` list items.
    - `templates` object[]
      - `slug` string
      - `name` string
    - `archived` boolean: Archived migrations stay readable and exportable but refuse uploads, runs and edits. Restore one from the Archived page in Vern.
    - `created_at` string, date-time
    - `url` string, uri: Opens the company in Vern. `/companies/open/{key}` also accepts the `external_id`.
  - `next_cursor` string, nullable: Pass as `cursor` for the next page; null on the last page.

## Other responses

- `400`: Malformed request.
- `401`: API key missing, malformed, or revoked.
- `409`: The source name is ambiguous, or your account's data region isn't live yet.
- `429`: Rate limit hit. Counted per account (company), not per API key or IP. Each endpoint is in one class: reads 30/minute, writes 30/minute, jobs (starting an export) 15/hour, agent (starting a run, answering, submitting credentials) 30/hour. Creating a migration and starting a `generate` run also have their own 30/hour caps. A separate per-IP ceiling absorbs floods before authentication. `Retry-After` gives the seconds until the window resets, alongside `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`.
- `500`: Unexpected server error.

## Changes

- **2026-11-08** `0ae6ef5f1887`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vern-so/apis/vern-api/changes/migrations/get.md)

---

[API](https://skmtc.dev/vern-so/apis/vern-api.md) - [All operations](https://skmtc.dev/vern-so/apis/vern-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vern-so/apis/vern-api/revisions/0ae6ef5f1887?raw)