Extracts

Run extracts in bulk

Queue the action for 1–1,000 accessible extractions. Requires extract UPDATE permission and an authenticated workspace user; service principals are not supported. Private connections must be owned by or shared with the caller. Supply date_from and date_to together or omit both. date_from must not be later than date_to. Running does not implicitly unpause an extraction. An identical retry with the same Idempotency-Key returns the existing task ID; reusing the key for a different action or resolved execution arguments returns 409. Keys are scoped to the agency, workspace and user and retained while the task exists. Selection validation and access checks still run on retries. This prevents duplicate submission, not repeated worker execution. Use the bulk status endpoint to poll progress.

post/api/v3/extracts/bulk-run/

Request

Headers

X-IM-WORKSPACE-IDinteger

Workspace ID headers is required when using cookie authentication

Idempotency-Keystring required

Client-generated key for one bulk operation; 1–128 printable ASCII characters. Use the same key for retries of the same operation and a new key for a new operation.

Request body

date_fromstring date nullable

Start date. Supply together with date_to or omit both.

date_tostring date nullable

End date. Must not precede date_from.

Response

Task submitted or an identical previous submission returned. Does not mean downloading has finished.

idstring uuid required

Task ID to poll through GET /api/v3/bulk/stream/{task_info_id}/.

Changes

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