Skip to main content
POST
Start an export

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.

Body

application/json

Provide slug or slugs; slugs wins if both are sent.

slug
string
slugs
string[]
fields
string[]

Column names to export, in the order given. Omit to export every column. Matched exactly and case-sensitively; an unrecognised name returns 400 rather than being ignored.

Example:
omit_empty
boolean
default:false

Drop columns with no data in any row, using the completed import's stored per-column coverage. Returns 409 (coverage_unavailable) when that coverage does not exist, rather than quietly exporting every column.

Response

Export queued.

job_id
string
status
enum<string>
Available options:
pending
format
enum<string>
Available options:
csv,
zip
total_rows
integer
status_url
string

Relative path of this job's status endpoint.