Get Import
Status, counts and the skipped/failed rows of an import.
API key access
leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/imports/{import_id}Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Path Parameters
uuidHeader Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/imports/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Workspace-Id: string"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"filename": "string",
"status": "previewed",
"encoding": "string",
"delimiter": "string",
"headers": [
"string"
],
"total_rows": 0,
"created_count": 0,
"updated_count": 0,
"skipped_count": 0,
"error_count": 0,
"suppressed_count": 0,
"mapping": [
{
"property1": null,
"property2": null
}
],
"options": {
"property1": null,
"property2": null
},
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"errors": [
{
"row": 0,
"status": "created",
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"reason": "string",
"message": "string",
"suppressed": [
"string"
]
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Commit Import
Import the uploaded rows with this mapping. 409 if the import was already committed. Returns a result per row (created / updated / skipped / error, with a reason) and the summary counts. Rows matching the suppression list are imported but reported in `suppressed` (they stay uncontactable), unless `skip_suppressed` is set. With `enrich: true` and `ENRICHMENT_ASYNC=true` (off by default) the leads the import creates or updates (not suppressed ones, at most 100 per import) are also queued for enrichment as background jobs; `options.enrich` is then `true`. Otherwise the flag is ignored. With `IMPORTS_ASYNC_MIN_ROWS` set (off by default), a file with at least that many data rows is imported by a background job instead: the response is 202 with the same body, `summary.status` `processing` and empty `results`. Poll `GET /imports/{import_id}` until it is `completed` (or `failed`): it then has the counts and the skipped or failed rows (`errors`).
Upload Leads Csv
Upload a CSV: detect encoding and delimiter, suggest a column mapping, preview 20 rows. Nothing is imported until `POST /imports/{id}/commit`.