---
title: "Get the preview"
method: GET
path: "/migrations/{migration_id}/preview"
tags: ["Runs"]
---

# Get the preview

`GET /migrations/{migration_id}/preview`

## Request

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

The latest generated preview — the proposed output, sheet-per-template. 404 until a generate/update run has produced one.

## Query parameters

- `fields` string
- `omit_empty` boolean

## Response `200`

The current preview.

- Preview
  - `status` string
  - `templates` object[]
    - `slug` string
    - `name` string
  - `sheets` object[]
    - `template` object
      - `slug` string
      - `name` string
    - `rows` array[]: Rows as a grid, header row first.
      - string[]
    - `invalid_cells` unknown[]
      - unknown

## Other responses

- `401`: API key missing, malformed, or revoked.
- `404`: The referenced resource isn't in your account.
- `429`: Rate limit hit. Counted per account, not per API key. Creating a migration and starting a `generate` run are limited to 30/hour each; answering a run is limited to 30/hour; reads allow 30/minute and writes 30/minute. `Retry-After` gives the seconds until the window resets, alongside `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`.

## Changes

- **2026-09-27** `1990c15edaad`: 2 info
  - added the new optional `query` request parameter `fields`
  - added the new optional `query` request parameter `omit_empty`
- **2026-06-18** `c5a09eb23a64`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vern-so/apis/vern-api/changes/migrations/:migration_id/preview/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/6ae61af2db81?raw)