> This page is for API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.spreadspace.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server.

# List exports

GET https://api.spreadspace.app/api/extractions/exports

Lists the exports you started, newest first. Filter with `status`; page with `cursor`.

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

Reference: https://docs.spreadspace.app/api/api-reference/extractions/list

## Authentication

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

## Request

### Query parameters

- `status` (enum, optional) — Filter to one status: `queued`, `running`, `cancelling`, `succeeded`, `failed` or `cancelled`; any other value is rejected with 400.
  - Allowed values: `queued`, `running`, `cancelling`, `succeeded`, `failed`, `cancelled`
- `cursor` (string, optional) — The `next_cursor` from the previous page.
- `limit` (integer, optional) — Page size, at most 200. Defaults to 50.

### Headers

- `SpreadSpace-Version` (string, optional) — Pin the API version, e.g. `2026-10-07`. Omit to get the latest. See [Versioning](https://docs.spreadspace.app/api/versioning).

## Response

### 200

OK

- `data` (list of ExtractionExportResponse, required)
- `has_more` (boolean, required)
- `next_cursor` (string, optional, nullable)

## Errors

### 400 Bad Request Error

Bad request: validation failed, the cursor is malformed, or the API version is unknown.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 401 Unauthorized Error

Unauthorized: the bearer token or API key is missing or invalid.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 402 Payment Required Error

Payment required: the standard error envelope with `type` `subscription_required` when the workspace has no active or trialing subscription, or `billing_required` where a plan entitlement applies.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 403 Forbidden Error

Forbidden: authentication succeeded but the caller is not permitted to perform this action, for example an API key missing the required scope, an embed session reaching a loan it was not minted for, or a feature outside the workspace's plan.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 404 Not Found Error

Not found: the resource does not exist or is not visible to the calling tenant.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 429 Too Many Requests Error

Too many requests: the rate limit was hit, or an idempotency-key replay is still in progress.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

### 500 Internal Server Error

Internal server error: an unexpected failure. Quote the `request_id` in support tickets. A mutation sent with an `Idempotency-Key` replays this fault under that key rather than re-running; confirm the resource state before resending with a new key.

- `error` (ApiErrorBody, required) — Inner body of the canonical API error envelope.

## Types

### ExtractionExportResponse

One export of extracted documents. `status` is `queued`, `running`, `cancelling`, `succeeded`, `failed`, or `cancelled`. While it is `succeeded`, `download_url` is minted fresh on every read and expires within minutes, so fetch the export again rather than storing the link. `expires_at` is when the export and its bundle are deleted; after that every endpoint answers 404. A failed export carries `error_code` (`no_documents_resolved`, `export_ceiling_exceeded`, `stale_running_exceeded`, or `internal_error`) and `error_message`.

- `export_id` (string, required)
- `status` (enum, required)
  - Allowed values: `queued`, `running`, `cancelling`, `succeeded`, `failed`, `cancelled`
- `progress` (ProgressCounts, required) — How much of the work is finished: `completed` out of `total`. Both are zero until the totals are known.
- `document_counts` (ExtractionExportDocumentCounts, required) — 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_ids` (list of string, required)
- `bundle` (ExtractionExportBundle, required, nullable) — The finished file: its name, its size in bytes, and how many line items it carries.
- `created_at` (datetime, required)
- `expires_at` (datetime, required)
- `links` (ExtractionExportLinks, required) — 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_id` (string, optional, nullable)
- `loan_id` (string, optional, nullable)
- `format` (enum, optional)
  - Allowed values: `xlsx`, `csv`, `json`
- `download_url` (string, optional, nullable)
- `download_expires_at` (datetime, optional, nullable)
- `error_code` (string, optional, nullable)
- `error_message` (string, optional, nullable)
- `started_at` (datetime, optional, nullable)
- `completed_at` (datetime, optional, nullable)

### ApiErrorBody

Inner body of the canonical API error envelope.

- `type` (string, required) — Stable error type identifier. Pattern-match on this value, not the human-readable message.
- `message` (string, required) — Human-readable error message. Subject to wording changes; do not parse.
- `request_id` (string, optional, nullable) — Per-request correlation ID (matches `X-Request-ID` response header). Quote in support tickets.
- `details` (map from string to string, optional, nullable) — Structured detail. Some error types populate documented keys in every environment: a version conflict (409) carries `current_version`, the version the resource is actually at, so the client can reload and re-apply. Free-form diagnostic detail beyond those keys appears in development environments only. An `insufficient_credits` 402 carries `balance_usd`, `reserved_usd`, `in_flight_docs`, `incoming_docs` and `per_doc_reservation_usd` as decimal strings.

### ProgressCounts

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

- `completed` (integer, required)
- `total` (integer, required)

### ExtractionExportDocumentCounts

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.

- `requested` (integer, required)
- `exported` (integer, required)
- `skipped` (integer, required)

### ExtractionExportBundle

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

- `name` (string, required)
- `size_bytes` (long, required)
- `line_item_count` (integer, required)

### ExtractionExportLinks

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.

- `self` (string, required)
- `cancel` (string, optional, nullable)
- `download` (string, optional, nullable)

## Examples

**Response**

```json
{
  "data": [
    {
      "export_id": "3c2b1a0f9e8d7c6b5a493827",
      "status": "succeeded",
      "progress": {
        "completed": 2,
        "total": 2
      },
      "document_counts": {
        "requested": 2,
        "exported": 2,
        "skipped": 0
      },
      "skipped_document_ids": [],
      "bundle": {
        "name": "extraction_export_2024-01-15.xlsx",
        "size_bytes": 48213,
        "line_item_count": 148
      },
      "created_at": "2024-01-15T09:30:00.125293+00:00",
      "expires_at": "2024-01-22T09:30:00.271621+00:00",
      "links": {
        "self": "/api/extractions/exports/3c2b1a0f9e8d7c6b5a493827",
        "cancel": null,
        "download": "/api/extractions/exports/3c2b1a0f9e8d7c6b5a493827/download"
      },
      "borrower_id": "9f8e7d6c5b4a3210a1b2c3d4",
      "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a",
      "format": "xlsx",
      "download_url": "https://storage.example.com/exports/3c2b1a0f9e8d7c6b5a493827/extraction_export_2024-01-15.xlsx?expires=420&signature=EXAMPLE",
      "download_expires_at": "2024-01-15T09:44:00.195820+00:00",
      "error_code": null,
      "error_message": null,
      "started_at": "2024-01-15T09:35:00.060530+00:00",
      "completed_at": "2024-01-15T09:37:00.203132+00:00"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

**SDK Code**

```python
import requests

url = "https://api.spreadspace.app/api/extractions/exports"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.spreadspace.app/api/extractions/exports';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spreadspace.app/api/extractions/exports"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.spreadspace.app/api/extractions/exports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.spreadspace.app/api/extractions/exports")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.spreadspace.app/api/extractions/exports', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.spreadspace.app/api/extractions/exports");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/extractions/exports")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```