Retrieve a document
Reads one extracted document: its envelope and its extracted object, whose first key, document_type, says which shape it has.
Requires the extractions:read 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
Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.
Response headers
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
The document’s lifecycle status: extracted,
duplicate, superseded, undated, paused,
unextractable or deleted.
The document’s type, which also names the shape of its
report_data.
Why an unextractable document was not extracted, when
there is a sentence for it; null otherwise.
The document this one duplicates, for a duplicate.
The extraction’s version; it moves with
updated_at when the extracted object changes.
When the document was deleted, for a deleted.
The extracted object, its first key document_type.
Served by the read, and by the list with include=report_data;
present as null when the document has no extracted object.