Skip to content

Get Migration Status

GET
/integrations/migrations/{migration_id}

Where the migration is, and what discovery found.

NOT admin-gated, matching the app: reading progress is not the privileged part, starting the import is.

Open-shaped, and deliberately: the payload carries a per-entity progress map, the discovered fields, the proposed mappings, the pipelines and a WARNINGS list. A dropped warning reads as “nothing went wrong”.

Authorizations

Parameters

Path Parameters

migration_id
required

Migration id.

string

Migration id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a connection, a token or a migration report.

Open because the migration STATUS payload carries a per-entity progress map, a discovered-field map and a pipeline list that all grow with the providers - and because a dropped warning on a migration report reads as “nothing went wrong”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string