API OverviewAPI EndpointsTransactions

Get bulk import job status

Check the status and progress of a bulk import job

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

jobIdstringRequired
The ID of the bulk import job

Query parameters

entityIdstringRequired
The ID of the entity that owns the job

Response

Job status retrieved successfully
jobIdstring or null
Job identifier
statusenum or null
Current job status
Allowed values:
progressinteger or null>=0<=100

Progress percentage (0-100)

totalRowsinteger or null
Total number of rows to process
processedRowsinteger or null
Number of rows processed so far
successCountinteger or null
Number of successfully created transactions
failedCountinteger or null
Number of failed transaction creations
errorslist of objects or null
startedAtstring or nullformat: "date-time"
When the job started processing
completedAtstring or nullformat: "date-time"

When the job completed (if finished)

createdAtstring or nullformat: "date-time"
When the job was created
isCompleteboolean or null
Whether the job has finished processing
hasErrorsboolean or null
Whether there are any errors
estimatedTimeRemaininginteger or null

Estimated seconds remaining (null if not calculable)

Errors