Extracts

Get bulk task status

Poll a JSON status response (not SSE) for a task submitted by this user in the current agency and workspace. Requires extract VIEW permission. Service principals are not supported. A success status means the action was processed, not that extraction downloading has completed. Inspect result counts and failures for partial failures, even when status is success. Bulk edit IDs are polled here too. A bulk edit changes all selected extractions or none, so its result is always empty; on error, error_text says why the settings were rejected, and internal failures are reported with a generic message.

get/api/v3/bulk/stream/{task_info_id}/

Request

Path parameters

task_info_idstring uuid required

Task ID returned by a bulk action or a bulk edit.

Headers

X-IM-WORKSPACE-IDinteger

Workspace ID headers is required when using cookie authentication

Response

Current task status.

status'in_progress' | 'success' | 'error' | 'cancelled' required

cancelled applies only to bulk edits.

error_textstring required

Changes

No recorded changes to this operation across all 1 revision of this API.