Get migration details

GET https://app.speybooks.com/api/v1/migrations/{id}

Retrieve full details of a migration session including status, all attached import IDs, reconciliation proof (if completed), and per-import summaries.

Import summaries include row counts, created/skipped/error counts, filename, and status for each linked importer.

Also returns the providerConfig for the selected provider (label, required imports, optional imports).

Path parameters

id string required
Migration ID (e.g. mig_1).

Response

200 Full migration with import summaries for contacts, balances, invoices, and bills.
Show response fields
id string
imports object
Show child attributes
balances object
Show child attributes
createdCount integer
importId string
status string
totalRows integer
contacts object
Show child attributes
createdCount integer
importId string
skippedCount integer
status string
totalRows integer
provider string
status string

Error codes

404 Migration not found.