> 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 all supporting tables GET https://api.spreadspace.app/api/borrowers/{borrower_id}/extractions/supporting-tables Lists every usable supporting table on the borrower's file. Pass `loan_id` to narrow the list to one loan. Requires the `extractions:read` scope. Rate limit: 200 requests per minute per key (the `api` lane). Reference: https://docs.spreadspace.app/api/api-reference/supporting-tables/get-supporting-tables ## 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 - `borrower_id` (string, required) — The borrower's id. ### Query parameters - `loan_id` (string, optional) — Narrow the list to one loan. ### 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 - `borrower_id` (string, required) — The borrower the documents belong to. - `tables` (list of SupportingTableReportDataListItem, required) — One row per document. ## 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 ### SupportingTableReportDataListItem One row of the Supporting Table list: the document's identity and its extracted object. - `extracted_document_id` (string, required) — Identifier of the extracted document. - `document_category` (string, required) — The document category the extraction is stored under. - `report_data` (SupportingTableReportData, required) — The extracted object, in the family's shape. ### 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. ### SupportingTableReportData A table printed in the notes to the financial statements, as printed: a debt table with its printed columns and rows, or a table printed as lines under its heads with one figure and one print mark per column. A figure printed as money is a decimal string with two decimals, in dollars; a percent, count or per-share figure keeps its printed figure. - `category` (string, required) — The note family the table belongs to, such as `debt` or `lease`. - `supports` (enum, required) — The balance sheet side, or the statement, the table supports. - Allowed values: `asset`, `liability`, `equity`, `balance_sheet`, `income_statement`, `cash_flow` - `shape` (string, required) — The table's layout, such as `maturity_schedule` or `debt_composition`. - `status` (enum, required) — `RECONCILED` when every check the table allows holds, `FLAGGED` when one does not, `PRINTED` when the table allows no check. - Allowed values: `RECONCILED`, `FLAGGED`, `PRINTED` - `columns` (SupportingTableReportDataColumns, required) — The figure columns: a count when the table heads them by period alone, the printed heads as objects, or on a debt table the printed heads as text with the label column first. - `reporting_unit` (enum, required) — The unit the figures are printed in, such as ones or thousands. - Allowed values: `ones`, `thousands`, `millions`, `billions` - `scale_multiplier` (integer, required) — Scale of the printed figures: 1 for whole dollars, 1000 when the table is stated in thousands, 1000000 when it is stated in millions. - `subject` (string, optional) — What the table is about, read off its caption and rows, such as `regulatory_capital`. - `signals` (list of SupportingTableReportData_StatementSignal, optional) — Each check of the table that does not hold, in words, when any does not. - `entity` (string, optional, nullable) — The reporting entity's name as printed, when the page prints one. - `title` (string, optional, nullable) — The table's caption or note heading as printed. - `heading` (string, optional, nullable) — The note heading printed over the table. - `caption` (string, optional, nullable) — The sentence printed over the table that introduces it. - `period` (string, optional, nullable) — The period wording printed over the table, such as the years ended, when it prints one. - `periods` (list of SupportingTableReportData_SupportingTablePeriod, optional) — The table's figure columns as periods, one entry per column. - `as_of` (string, optional, nullable) — The as-of date the table states. - `as_of_printed` (string, optional, nullable) — The as-of date as printed. - `as_of_date` (string, optional) — The as-of date of a debt table, as a `YYYY-MM-DD` date or as printed. - `label_head` (string, optional, nullable) — The printed head of the label column, when the table prints one. - `column_kinds` (list of string, optional) — What each column holds, in `columns` order, such as `label`, `money`, `rate`, `year` or `text`. - `column_heads` (list of SupportingTableReportData_SupportingTableHead, optional) — The heads printed over the figure columns, in order, when the table heads them apart from `columns`. - `classes` (list of SupportingTableReportData_SupportingTableHead, optional) — The classes printed over the figure columns, in order. - `plan_groups` (list of SupportingTableReportData_SupportingTableHead, optional) — The bands printed over runs of columns, in order. - `lines` (list of SupportingTableReportData_SupportingTableLine, optional) — The table's printed rows in order, each with one figure and one print mark per column. - `applicant` (string, optional, nullable) — The reporting entity's name as printed over the debt table, when the page prints one. - `label_terms` (list of string, optional) — Which of `interest_rate` and `maturity_date` the rows state in their labels. - `creditor_column` (string, optional) — The head of the column that names each debt. - `balance_column` (string, optional) — The head of the column that holds the balances. - `balance_column_index` (integer, optional) — Position of the balance column in `columns`, counting from zero. - `total_balance` (string, optional, nullable) — The balance column's total. - `printed_total_balance` (string, optional, nullable) — The total the table prints under the balance column. - `debt_schedule` (list of SupportingTableReportData_SupportingTableDebtRow, optional) — The debt table's printed rows in order, captions and totals included. - `direction` (enum, optional) — On a related-party table, whether the balances are owed to the company (`receivable_from`) or by it (`payable_to`). - Allowed values: `receivable_from`, `payable_to` - `consolidated_counterparty` (string, optional, nullable) — The related party the table is with, when it names one. - `footnotes` (list of SupportingTableReportData_SupportingTableFootnote, optional) — The footnotes printed under the table, in page order. - `cpa_engagement` (integer, optional) — The accountant's level of assurance: 0 unaudited, 1 compiled, 2 reviewed, 3 audited. - `cpa_engagement_label` (string, optional) — The assurance level in words. - `presentation` (enum, optional) — How the statement is presented: `formal` when it is presented as issued financial statements; `free_form` when it is a report out of the books (accounting software or a spreadsheet). - Allowed values: `formal`, `free_form` - `billing_years` (integer, optional) — Years of data billed for the table. - `packet` (SupportingTableReportData_PacketProvenance, optional) — Where the table sat in the financial statement packet it arrived in, when it arrived in one. ### SupportingTableReportDataColumns The figure columns: a count when the table heads them by period alone, the printed heads as objects, or on a debt table the printed heads as text with the label column first. ### SupportingTableReportData_StatementSignal A check of the table that does not hold, or a note about its reporting period. - `severity` (enum, required) — How much weight the note carries: info or warn. - Allowed values: `info`, `warn` - `code` (enum, required) — The note's identifier. - Allowed values: `coverage_unreadable`, `debt_maturity_class_total_mismatch`, `debt_maturity_total_mismatch`, `debt_total_mismatch`, `eps_quotient_mismatch`, `interest_other_total_mismatch`, `lease_class_total_mismatch`, `lease_payments_total_mismatch`, `lease_present_value_mismatch`, `lease_split_mismatch`, `no_reporting_period`, `notes_cross_foot_mismatch`, `notes_cross_table_mismatch`, `notes_percent_mismatch`, `notes_rollforward_mismatch`, `notes_total_mismatch`, `year_from_file_metadata`, `year_from_filename`, `year_from_page_image`, `year_matches_print_stamp` - `detail` (string, required) — The note in words. ### SupportingTableReportData_SupportingTablePeriod One figure column as a period. - `label` (string, required, nullable) — The column heading as printed. - `coverage` (string, optional, nullable) — The span the column covers as printed, when the table prints one. - `start` (string, optional, nullable) — First day of the period the column covers, when it can be dated. - `end` (string, optional, nullable) — Last day of the period the column covers, or the date the column is as of, when it can be dated. - `kind` (string, optional, nullable) — What the column's date is, such as a period or an as-of date, when it is dated. - `as_of` (string, optional, nullable) — The date the column is as of, as a `YYYY-MM-DD` date or as printed. - `as_of_printed` (string, optional, nullable) — The date the column is as of, as printed. ### SupportingTableReportData_SupportingTableHead One head printed over the figure columns. - `label` (string, required, nullable) — The head as printed. - `kind` (string, optional, nullable) — What the head names, when it names one. ### SupportingTableReportData_SupportingTableLine One printed row. - `label` (string, required) — The row's caption as printed. - `kind` (string, required) — The row's kind, such as `item`, `caption` or `total`. - `values` (list of string, required) — The row's figure per column as printed and scaled by the reporting unit, a percent, count or per-share figure as printed, text where the cell prints words; null where the cell is blank. - `printed` (list of enum, required) — How each cell is printed, per column: `money`, `dash` for a printed dash, `blank` for an empty cell, `text` for words. - Allowed values: `money`, `dash`, `blank`, `text` - `indent` (integer, optional) — How far the row is indented under its caption. - `level` (integer, optional) — The row's depth under its caption. - `year` (integer, optional, nullable) — The year a maturity row is for. - `percent` (list of boolean, optional) — Per column, whether the row's figure is a percent. - `cell_kinds` (list of string, optional) — Per column, the kind of each cell when it differs from its column, such as `money`, `count`, `per_share`, `percent`, `price` or `text`. - `label_marks` (list of string, optional) — The footnote marks the row's label wears. ### SupportingTableReportData_SupportingTableDebtRow One printed row of a debt table. - `cells` (list of string, required) — The row's cells in column order as printed, the label first. - `is_total` (boolean, required) — True when the row is a printed total. - `creditor_name` (string, required, nullable) — The debt the row names, on a debt or a total row; null on a caption or an adjustment. - `current_balance` (string, required, nullable) — The balance from the balance column, on a debt or a total row; null on a caption, an adjustment or a blank cell. - `interest_rate` (string, optional, nullable) — Interest rate as printed, when a column or the row's label carries it. - `maturity_date` (string, optional, nullable) — Maturity as printed, when a column or the row's label carries it. - `payment_amount` (string, optional, nullable) — Payment amount as printed, when a column carries it. - `payment_frequency` (string, optional, nullable) — Payment frequency as printed, when a column carries it. - `original_amount` (string, optional, nullable) — Original amount as printed, when a column carries it. - `how_secured` (string, optional, nullable) — Collateral or security as printed, when a column carries it. - `cell_marks` (list of list of string, optional) — The footnote marks each cell wears, in column order; null where a cell wears none. ### SupportingTableReportData_SupportingTableFootnote One footnote printed under the table. - `mark` (string, required) — The footnote's mark as printed, such as `1` or `a`. - `text` (string, required) — The footnote in words. ### SupportingTableReportData_PacketProvenance Where a statement sat in the financial statement packet it arrived in, when it arrived in one. - `section_index` (integer, required) — Position of the statement among the packet's statements, counting from zero. - `pages` (list of integer, required) — First and last page of the statement within the packet, counting from one. - `letter_date` (string, required, nullable) — Date of the accountant's letter that accompanied the packet, when the letter printed one. - `letter_page` (integer, required, nullable) — Page of the packet the accountant's letter is on, when the packet carries one. - `page_list` (list of integer, optional) — Every page of the packet the statement is printed on, counting from one, when they are not one unbroken run; absent otherwise. ## Examples **Response** ```json { "borrower_id": "3f9c2b1e8d7a4c5b9e0f1a2b", "tables": [ { "extracted_document_id": "7a1d4e9c2b3f4a5d8e6c1b0f", "document_category": "supporting_table", "report_data": { "category": "lease", "supports": "liability", "shape": "maturity_schedule", "status": "RECONCILED", "columns": 2, "reporting_unit": "millions", "scale_multiplier": 1000000, "subject": "leases", "entity": "GREENFIELD CONSTRUCTION LLC", "title": "Maturities of operating and finance lease liabilities as of December 27, 2025 were as follows:", "as_of": "2025-12-27", "as_of_printed": "December 27, 2025", "classes": [ { "label": "Operating Leases", "kind": "operating" }, { "label": "Finance Leases", "kind": "finance" } ], "lines": [ { "label": "2026", "kind": "year", "values": [ "93000000.00", "11000000.00" ], "printed": [ "money", "money" ], "year": 2026 }, { "label": "2027", "kind": "year", "values": [ "76000000.00", "7000000.00" ], "printed": [ "money", "money" ], "year": 2027 }, { "label": "2028", "kind": "year", "values": [ "57000000.00", "4000000.00" ], "printed": [ "money", "money" ], "year": 2028 }, { "label": "2029", "kind": "year", "values": [ "46000000.00", "3000000.00" ], "printed": [ "money", "money" ], "year": 2029 }, { "label": "2030", "kind": "year", "values": [ "33000000.00", "0" ], "printed": [ "money", "dash" ], "year": 2030 }, { "label": "Thereafter", "kind": "thereafter", "values": [ "61000000.00", "0" ], "printed": [ "money", "dash" ], "year": null }, { "label": "Total undiscounted lease payments", "kind": "payments_total", "values": [ "366000000.00", "25000000.00" ], "printed": [ "money", "money" ], "year": null }, { "label": "Less imputed interest", "kind": "imputed_interest", "values": [ "49000000.00", "3000000.00" ], "printed": [ "money", "money" ], "year": null }, { "label": "Present value of lease liabilities", "kind": "present_value", "values": [ "317000000.00", "22000000.00" ], "printed": [ "money", "money" ], "year": null } ], "billing_years": 1 } } ] } ``` **SDK Code** ```python import requests url = "https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/supporting-tables" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/supporting-tables'; const options = {method: 'GET', headers: {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/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/supporting-tables" req, _ := http.NewRequest("GET", url, nil) 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/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/supporting-tables") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) 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/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/supporting-tables") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/supporting-tables', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/supporting-tables"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.spreadspace.app/api/borrowers/3f9c2b1e8d7a4c5b9e0f1a2b/extractions/supporting-tables")! 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() ```