Cancel export
Cancels an export. A queued export is cancelled at once; a running one moves to cancelling and stops at its next document boundary. An export that already finished returns a 409; one already cancelled is returned unchanged. Cancelling a queued export emits export.cancelled; a running one emits it when the worker stops.
Requires the extractions:export scope. Rate limit: 200 requests per minute per key (the api lane).
Authentication
Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.
Path parameters
Headers
Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See Idempotency.
Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.
Response headers
Set to true when the response is replayed from the idempotency cache for a request that re-presented an Idempotency-Key it had already used. Absent on the original (winner) response. A replay repeats the original status and body. When the original could not be stored (an unhandled server fault, or a body over the 1 MiB replay cap) the replay is an error envelope that says so; the operation is never re-run under the same key.
The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.
Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.
Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.
Seconds until a guaranteed-fresh window.
The active policy in limit;w=window-seconds form.
Response
How much of the work is finished: completed out of
total. Both are zero until the totals are known.
How the selection turned out: requested is what the caller
named, exported is what landed in the bundle, and skipped
counts the ids that did not resolve inside the borrower and loan.
The finished file: its name, its size in bytes, and how many line items it carries.
Where to go next. self re-reads the export; cancel is
present only while it can still be stopped; download appears once the
bundle is ready.