Get export | SpreadSpace

{
  "export_id": "exp_9f8b7c6d5e4a3b2c1d0e9f8a",
  "status": "running",
  "progress": {
    "completed": 3,
    "total": 10
  },
  "document_counts": {
    "requested": 10,
    "exported": 3,
    "skipped": 0
  },
  "skipped_document_ids": [],
  "bundle": null,
  "created_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-22T09:30:00Z",
  "links": {
    "self": "/api/extractions/exports/exp_9f8b7c6d5e4a3b2c1d0e9f8a",
    "cancel": "/api/extractions/exports/exp_9f8b7c6d5e4a3b2c1d0e9f8a/cancel",
    "download": null
  },
  "borrower_id": "brw_4a2c8e1f6b3d5a7c9e0f",
  "loan_id": "loan_7d1e3b5a9c2f4e6b8d0a",
  "format": "xlsx",
  "download_url": null,
  "download_expires_at": null,
  "error_code": null,
  "error_message": null,
  "started_at": "2024-01-15T09:35:00Z",
  "completed_at": null
}

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.

Authentication

AuthorizationBearer

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

Bearer token. Use `ss_live_…` for live data or `ss_test_…` for the sandbox (test mode). See [Authentication](https://docs.spreadspace.app/api/authentication).

Path parameters

exportIdstringRequired

The export's id.

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-07-19.

RateLimit-Limitinteger

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

Request budget of the endpoint's rate-limit policy per 60-second sliding window. See [Rate limits](https://docs.spreadspace.app/api/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

export_idstring

statusstring

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

linksobject

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.

borrower_idstring or nullOptional

loan_idstring or nullOptional

formatstring or nullOptional

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

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

$	curl https://api.spreadspace.app/api/extractions/exports/exportId \
>	-H "Authorization: Bearer <token>"

Authentication

Path parameters

Headers

Response headers

Response

Errors