Get list migration progress (Preview)

Preview · Available to selected organizations. Returns the visible import job's committed counts, generation, terminal failure and resumability.

GET
/v1/contacts/imports/{id}

Returns the visible import job's committed counts, generation, terminal failure and resumability. The job persists across worker restarts and page reloads. Admitted jobs remain readable when listMigration is disabled.

x-api-key<token>

In: header

Path Parameters

id*string
Match^cimport_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/contacts/imports/string"
{  "id": "string",  "namespaceId": "string",  "topicId": "string",  "preset": "beehiiv",  "status": "queued",  "generation": 0,  "counts": {    "totalRows": 0,    "uniqueAddresses": 0,    "subscribed": 0,    "unsubscribed": 0,    "suppressed": 0,    "skipped": 0,    "conflicts": 0,    "created": 0,    "existing": 0  },  "processedRows": 0,  "totalRows": 0,  "createdAt": "string",  "startedAt": "string",  "updatedAt": "string",  "completedAt": "string",  "failure": {    "code": "string",    "message": "string",    "retryable": true  },  "resumable": true}

Related documentation