Skip to main content
GET
Get the status of a background task by its taskId.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

taskId
string
required

Response

Current status of the background task

Status of an asynchronous background task (e.g. a deduplication or import). Poll until status is a terminal value: "completed", "failed", or "cancelled" (non-terminal: "pending", "running").

actionId
string

Action the task relates to (UUID), if any.

companyId
string

Company that owns the task.

completedDate
string

When the task finished (ISO 8601), if terminal.

createdDate
string

When the task was created (ISO 8601).

errorMessage
string

Error detail when status is "failed".

failedItems
integer

Items that failed.

id
string

Task ID (UUID) — the taskId returned by the operation that started the task.

listId
string

List the task operates on (UUID), if any.

nodeId
string

Server node processing the task.

processedItems
integer

Items processed so far.

progressMessage
string

Human-readable progress note.

progressPercentage
number

processedItems / totalItems as a percentage (0 when total is unknown).

result
string

Task-specific result payload, populated when completed (shape depends on taskType).

startedDate
string

When processing began (ISO 8601), if started.

status
string

Current status: "pending", "running", "completed", "failed", or "cancelled". The first two are non-terminal — keep polling; the last three are terminal.

successItems
integer

Items processed successfully.

taskMetadata
string

Task-specific input/config (e.g. the columnNames a dedup ran on).

taskType
string

Kind of task, e.g. "Deduplicate", "import", "people_search".

totalItems
integer

Total items the task will process (0 until known).

updatedDate
string

Last update (ISO 8601).

userId
string

User who started the task.