Get migration details

GEThttps://app.speybooks.com/api/v1/migration/{id}

Retrieve full details of a migration session: its status, the attached import ids, the reconciliation proof (once completed), and a per-import summary. Each import summary carries the row count and the created, skipped, and error counts for that importer, along with its filename and status. The provider configuration (label, required imports, optional imports) is returned as well.

Path parameters

idstringrequired

Migration ID (e.g. mig_1).

Response

200Full migration with import summaries for contacts, balances, invoices, and bills.

Show response fields

idstring

importsobject

Show child attributes

balancesobject

Show child attributes

createdCountinteger

importIdstring

statusstring

totalRowsinteger

contactsobject

Show child attributes

createdCountinteger

importIdstring

skippedCountinteger

statusstring

totalRowsinteger

providerstring

statusstring

Error codes

404Migration not found.

RequestGET/v1/migration/{id}curl

curl https://api.speybooks.com/v1/migration/mig_1 \
  -H "Authorization: Bearer sk_test_..."

Response200

{
  "success": true,
  "data": {
    "id": "mig_1",
    "provider": "freeagent",
    "status": "ready_to_execute",
    "imports": {
      "contacts": {
        "importId": "dimp_5",
        "status": "confirmed",
        "totalRows": 42,
        "createdCount": 40,
        "skippedCount": 2
      },
      "balances": {
        "importId": "dimp_6",
        "status": "confirmed",
        "totalRows": 28,
        "createdCount": 28
      }
    }
  }
}