Get batch job status
API Reference
Get batch job status
Poll batch import job status, progress, and row counters by jobId for entity, transaction, and user-event CSV imports in the gu1 batch API.
GET
Get batch job status
Endpoint
202 with a jobId. It resolves the job kind automatically and performs a direct lookup β it does not scan the full import history.
Authentication
transactions:create, entities:bulk_import, events:create.
Query parameters
HTTP responses
Recommended polling flow
- Upload (entities, transactions, or user events) β store
jobIdfrom the202response. - Poll
GET /batch-import/jobs/{jobId}every 2β5 seconds. - Stop when
statusis terminal:completed,failed,cancelled, orinterrupted. - If you need row-level detail, call again with
?include=failuresor use the kind-specific failures endpoint (see Bulk imports overview).
For listing recent jobs (dashboard-style), use Unified history. For polling a single job, prefer this endpoint.
JSON response (default β status only)
boolean
Always
true when the job exists.string
Batch job identifier from the upload response.
string
entity_batch (alias entity_automatic), transaction_batch, or user_event_batch.string
queued, running, completed, failed, cancelled, or interrupted. While a cancel is in progress the job may still show running with metadata.batchCancelRequested.number | null
Total rows/items in the job.
number | null
Successfully processed count.
number | null
Failed row count.
number | null
Skipped row count (e.g. duplicate taxId on entity imports).
string | null
Last worker heartbeat (ISO 8601).
string | null
Worker lease expiry (ISO 8601).
string | null
Truncated worker error when the job failed at job level.
string
Job creation time (ISO 8601).
string | null
Completion time when terminal (ISO 8601).
object | null
Job metadata (e.g.
fileName, import mode).object | null
Present when
status is failed and the whole job aborted. Includes stable code and message β see Failure codes.JSON response with ?include=failures
Same contract as the kind-specific failures JSON endpoints:
- Entities: Entity batch failures
- Transactions: Transaction batch failures
- User events: User-event batch failures
failures is an empty array (failuresTotal: 0).
See also: Bulk imports overview, Unified history.