Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Project-scoped API key, e.g. nohead_sk_k7fz0a9c3m2q_<secret>, or nohead_pk_… for a published-only key. Used by servers, CI, the CLI and coding agents.

Path Parameters

migration_id
string
required
Example:

"mig_01J9ZQ3F8X5W2K7M4N6P0R1S2T"

Response

The migration.

id
string
required
Example:

"mig_01J9ZQ3F8X5W2K7M4N6P0R1S2T"

object
any
required
collection_id
string
required
field_id
string
required
status
enum<string>
required
Available options:
pending,
running,
complete,
failed,
cancelled
from
object
required
to
object
required
backfill
null | object
required

{"value": ...} when missing values are filled in, otherwise null.

on_invalid
enum<string>
required
Available options:
fail,
clear
time_zone
string | null
required

The time zone dates were read in when include_time was turned off, if one was given.

records
object
required

Records by outcome, including soft-deleted records (which are converted but never backfilled).

failure
null | object
required

Why the migration failed; null otherwise. A failed migration changed nothing.

schema_change_id
string | null
required

The migrate_field schema change, once complete.

cancel_requested_at
string<date-time> | null
required

When cancelling was asked for, while a running migration rolls back.

actor
object
required
via
enum<string>
required

The client a change came through; scheduler for scheduled changes.

Available options:
ui,
api,
cli,
sdk,
mcp,
system,
scheduler
note
string | null
required
request_id
string | null
required
created_at
string<date-time>
required

ISO 8601 timestamp in UTC.

Example:

"2026-09-27T12:00:00.000Z"

started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required