Skip to main content
GET
Get the queue-processing status for a table action.

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

actionId
string
required
listId
string
required

Query Parameters

actionType
string
required

Action type (see LIST_ACTION_TYPE_* constants). Required.

includeDetails
boolean
default:false

When true, include per-item queue details in addition to the aggregate counts. Default: false.

companyId
string

Company ID that owns the list. Required when authenticating with a personal access key (pak_…) — the key is not tied to a specific company so the server cannot infer it. Required when authenticating with a company API key only if the key belongs to a user who has access to multiple companies; otherwise it defaults to the key's company. Optional for JWT (dashboard) auth — defaults to the user's active company.

Response

Queue processing status for the action

Queue-processing status for a table action: aggregate counts of rows in each processing state, plus optional per-item details when includeDetails=true.

completed
integer

Number of items that finished successfully.

details
object[]

Per-item queue details. Present only when includeDetails=true.

failed
integer

Number of items that failed.

pending
integer

Number of items still waiting to be processed.

processing
integer

Number of items currently processing.

total
integer

Total number of queued items for this action.