Skip to main content
GET
/
migrations
/
{migration_id}
/
preview
Get the preview
curl --request GET \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/preview \
  --header 'x-api-key: <api-key>'
{
  "status": "awaiting_approval",
  "templates": [
    {
      "slug": "contacts",
      "name": "Contacts"
    }
  ],
  "sheets": [
    {
      "template": {
        "slug": "contacts",
        "name": "Contacts"
      },
      "rows": [
        [
          "Email",
          "First Name",
          "Last Name"
        ],
        [
          "jane@acme.com",
          "Jane",
          "Doe"
        ]
      ],
      "invalid_cells": []
    }
  ]
}

Authorizations

x-api-key
string
header
required

Your Vern API key. Create one at Settings → API keys.

Path Parameters

migration_id
string<uuid>
required

The migration ID returned by Create a migration.

Response

The current preview.

status
string
Example:

"awaiting_approval"

templates
object[]
sheets
object[]