> 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 borrower jobs GET https://api.spreadspace.app/api/borrowers/{id}/jobs Lists the borrower's uploads. Returns an array (not a paginated envelope) of jobs, newest first, at most 200 of them borrower-wide. Pass `loan_id` to scope the list to one loan of this borrower, which raises the cap to 1000. For a borrower-wide history past 200, page `GET /api/jobs` and filter by `borrower_id`. Requires the `jobs:read` scope. Rate limit: 200 requests per minute per key (the `api` lane). Reference: https://docs.spreadspace.app/api/api-reference/borrowers/list-jobs ## 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 ### Path parameters - `id` (string, required) — The borrower's id. ### Query parameters - `limit` (integer, optional, default: 50) — Page size. Defaults to 50; at most 200 borrower-wide, or at most 1000 when you pass `loan_id`. - `loan_id` (string, optional) — Optional. Scopes the list to a single loan of this borrower, filtered server-side. This is the way to list one loan's uploads: without it a page can be filled by the borrower's other loans. ### 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 - `list of JobStatusResponse` ## 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 ### JobStatusResponse - `job_id` (string, required) - `status` (enum, required) - Allowed values: `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED` - `total_files` (integer, required) - `completed_files` (integer, required) - `failed_files` (integer, required) - `extracted_document_ids` (list of string, required) — Ids of the extracted documents produced by this job, in creation order. A single PDF that splits into N child documents yields N ids; empty when no documents have been ingested yet. - `created_at` (datetime, required) - `updated_at` (datetime, required) - `borrower_id` (string, optional, nullable) - `loan_id` (string, optional, nullable) - `processing_started_at` (datetime, optional, nullable) - `processing_completed_at` (datetime, optional, nullable) - `error_message` (string, optional, nullable) - `unextractable_reason` (string, optional, nullable) — A sentence you can show the uploader when the job's document could not be extracted for a reason we name, for example a bank statement that did not include all of its pages. Null otherwise. - `category` (string, optional, nullable) — Document category resolved from the extracted document(s) for this job. One category is reported even when a document split into several. Null until extraction results have been ingested. - `extraction_source` (string, optional, nullable) — Set when the category-determining document came from a Plaid or Finicity response rather than a document file, and names that response kind. Null otherwise. ### 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. ## Examples **Response** ```json [ { "job_id": "9f8b7c6d5e4a3b2c1d0e9f8a", "status": "COMPLETED", "total_files": 1, "completed_files": 1, "failed_files": 0, "extracted_document_ids": [ "9a7c6b5d4e3f210987654321" ], "created_at": "2024-01-15T09:30:00.125293+00:00", "updated_at": "2024-01-15T09:32:41.207435+00:00", "borrower_id": "9f8e7d6c5b4a3210a1b2c3d4", "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a", "processing_started_at": "2024-01-15T09:30:05.221621+00:00", "processing_completed_at": "2024-01-15T09:32:41.207435+00:00", "error_message": null, "category": "profit_and_loss", "extraction_source": null }, { "job_id": "1a2b3c4d5e6f789012345678", "status": "PROCESSING", "total_files": 3, "completed_files": 1, "failed_files": 0, "extracted_document_ids": [], "created_at": "2024-01-16T08:15:00.828676+00:00", "updated_at": "2024-01-16T08:15:03.513200+00:00", "borrower_id": "9f8e7d6c5b4a3210a1b2c3d4", "loan_id": "9f8b7c6d5e4a3b2c1d0e4f5a", "processing_started_at": "2024-01-16T08:15:03.513200+00:00", "processing_completed_at": null, "error_message": null, "category": null, "extraction_source": null } ] ``` **SDK Code** ```python import requests url = "https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/jobs" querystring = {"limit":"25"} headers = { "SpreadSpace-Version": "2026-10-07", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/jobs?limit=25'; const options = { method: 'GET', headers: {'SpreadSpace-Version': '2026-10-07', Authorization: 'Bearer '} }; 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/borrowers/9f8e7d6c5b4a3210a1b2c3d4/jobs?limit=25" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("SpreadSpace-Version", "2026-10-07") req.Header.Add("Authorization", "Bearer ") 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/borrowers/9f8e7d6c5b4a3210a1b2c3d4/jobs?limit=25") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["SpreadSpace-Version"] = '2026-10-07' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/jobs?limit=25") .header("SpreadSpace-Version", "2026-10-07") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/jobs?limit=25', [ 'headers' => [ 'Authorization' => 'Bearer ', 'SpreadSpace-Version' => '2026-10-07', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/jobs?limit=25"); var request = new RestRequest(Method.GET); request.AddHeader("SpreadSpace-Version", "2026-10-07"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "SpreadSpace-Version": "2026-10-07", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/borrowers/9f8e7d6c5b4a3210a1b2c3d4/jobs?limit=25")! 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() ```