Get the preview

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>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.vern.so/api/v1/migrations/{migration_id}/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.vern.so/api/v1/migrations/{migration_id}/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.vern.so/api/v1/migrations/{migration_id}/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.vern.so/api/v1/migrations/{migration_id}/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": []
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Too many requests"
}

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.

Query Parameters

fields

string

Comma-separated column names to return, in the order given. Omit to return every column. Names are matched exactly and are case-sensitive — they are the same names used as CSV headers. An unrecognised name returns 400 (unknown_field) rather than being ignored, so a typo cannot silently leave data out of the response.

omit_empty

boolean

default:false

Drop columns that hold no data. A column is dropped only when it is empty in every row, so the rows you get back all keep the same shape. Empty means an empty string, null, or an absent value; whitespace counts as data. Combine with fields and the pruning applies within your selection.

How "empty" is decided depends on the endpoint. For exports it is read from the completed import's stored per-column coverage, so it reflects the whole sheet and stays stable across downloads; if that coverage is unavailable the request returns 409 (coverage_unavailable) rather than quietly returning every column. For the preview and extraction endpoints the returned rows are the entire payload, so emptiness is decided from them directly.

Response

The current preview.

status

string

Example:

"awaiting_approval"

templates

object[]

Show child attributes

sheets

object[]

Show child attributes

Get the preview

curl --request GET \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/preview \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.vern.so/api/v1/migrations/{migration_id}/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.vern.so/api/v1/migrations/{migration_id}/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.vern.so/api/v1/migrations/{migration_id}/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.vern.so/api/v1/migrations/{migration_id}/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": []
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "Too many requests"
}

Overview

Catalog

Migrations

Runs

Export

Authorizations

Path Parameters

Query Parameters

Response