/v1/definitions/{key}/import/jobs/{jobId}Read an import job's progress
How far one import job has got: state (running | completed | failed), total rows it was given, done rows it has finished with, failed rows refused, imported rows landed, and the first 20 refusals with their row numbers in the file. This read MAKES progress — it lands the job's next chunks of 1000 rows for about three seconds before it answers — so read it again at once while it moves and about once a second when it does not, until the state is terminal. A job nobody reads still finishes: the service carries on any job left unread for half a minute. Two reads at once never land the same chunk twice; the second answers the counts as they stand. done counts every finished row whatever became of it, so it reaches total even on a file with duplicates the policy skipped. A job nothing has moved for 24 hours is settled failed as too old to resume, and the import must be run again. The full per-row report and the undo live on get_definitions_key_imports.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": {
"actorUserId": 1,
"blankedCells": [
{
"count": "string",
"reason": "string",
"rows": "string"
}
],
"created": 1,
"done": 1,
"error": "string",
"errors": [
{
"error": "string",
"row": "string"
}
],
"failed": 1,
"fileName": "string",
"finishedAt": "2026-01-01T00:00:00Z",
"id": "",
"imported": 1,
"optionsAdded": [
{
"columnId": "",
"groups": "string",
"label": "string",
"values": "string"
}
],
"startedAt": "2026-01-01T00:00:00Z",
"state": "string",
"total": 1,
"updated": 1
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}