/v1/workspaces/{workspace_id}/contacts/imports/{import_id}AuthGet a contact import and its progress
Path parameters
workspace_id*string · uuidId of the workspace.
import_id*string · uuidId of the import.
Response · 200
id*string · uuidThe import id.
status*objectWhere the import is: `queued`, `processing`, then `completed` or `failed`.
on_conflict*objectWhat happens to a row whose email is already a contact: `upsert` updates it, `skip` leaves it.
filename*stringThe uploaded file's name, if one was given.
size_bytes*numberSize of the uploaded CSV in bytes.
consent_source*stringWhere the consent for these contacts came from, stored on every imported contact.
topic_ids*arrayTopics every imported contact was subscribed to.
total_rows*numberData rows in the file (header excluded); 0 until processing starts.
processed_rows*numberRows processed so far.
created_count*numberRows that created a new contact.
updated_count*numberRows that updated an existing contact.
skipped_count*numberExisting contacts left alone (`skip`), and duplicate rows.
error_count*numberRows that could not be imported.
consented_count*numberRows that asserted consent.
errors*arrayThe first 100 problems, with line numbers.
failure_reason*stringWhy a `failed` import stopped.
created_at*string · date-timeWhen the import was submitted.
started_at*string · date-timeWhen processing started; null while `queued`.
completed_at*string · date-timeWhen processing finished; null until then.
Example
Request
GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/contacts/imports/{import_id}
Authorization: Bearer YOUR_TOKENResponse
{
"id": "00000000-0000-0000-0000-000000000000",
"status": {},
"on_conflict": {},
"filename": "string",
"size_bytes": 0,
"consent_source": "string",
"topic_ids": [
"00000000-0000-0000-0000-000000000000"
],
"total_rows": 0,
"processed_rows": 0,
"created_count": 0,
"updated_count": 0,
"skipped_count": 0,
"error_count": 0,
"consented_count": 0,
"errors": [
{
"line": 0,
"error": "invalid or missing email"
}
],
"failure_reason": "string",
"created_at": "2026-01-01T00:00:00.000Z",
"started_at": "2026-01-01T00:00:00.000Z",
"completed_at": "2026-01-01T00:00:00.000Z"
}