Skip to navigation

Get export

Retrieves one export so you can poll it until status is terminal. A succeeded export carries a download_url minted fresh on each read. An export started by someone else returns a 404.

Requires the extractions:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

export_idstringRequired
The export's id.

Headers

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
SpreadSpace-VersionstringOptional

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.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

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.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
export_idstring
statusenum
progressobject

How much of the work is finished: completed out of total. Both are zero until the totals are known.

document_countsobject

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.

skipped_document_idslist of strings
bundleobject or null

The finished file: its name, its size in bytes, and how many line items it carries.

created_atdatetime
expires_atdatetime
borrower_idstring or nullOptional
loan_idstring or nullOptional
formatenumOptional
Allowed values:
download_urlstring or nullOptional
download_expires_atdatetime or nullOptional
error_codestring or nullOptional
error_messagestring or nullOptional
started_atdatetime or nullOptional
completed_atdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error