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

# Get attribute snapshot

GET https://api.spreadspace.app/api/loans/{loan_id}/attributes/{snapshot_id}

Retrieves one attribute snapshot by id, with its payload. A snapshot under another loan returns a 404.

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

Reference: https://docs.spreadspace.app/api/api-reference/spreads/get-by-id

## 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

- `loan_id` (string, required) — The loan's id.
- `snapshot_id` (string, required) — The snapshot's id.

### 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

- `snapshot_id` (string, required)
- `version` (integer, required) — Per-loan version number, counting up across every status.
- `status` (enum, required) — `final` (what an analyst approved at finalize), `machine` (the same loan built from the documents alone, with no analyst input) or `draft` (the latest autosave).
  - Allowed values: `final`, `machine`, `draft`
- `created_at` (datetime, required)
- `payload` (any, required) — The figures, in the `attributes.v1` payload schema: the fiscal periods, the named attributes and ratios keyed over them, and the analyst inputs that shaped them. Stored opaque and returned as stored; the name-by-name catalog is on the Spreads page in the API docs.
- `manifest` (any, required) — What the payload was built from: the documents it drew on, a count-level summary of the analyst inputs, the entity scope, and when it was built. Stored opaque, documented alongside the payload on the Spreads page.
- `spread_board_id` (string, optional, nullable) — The saved spread these values were taken from, when one is known.
- `finalized_at` (datetime, optional, nullable) — When the analyst finalized. Set on `final` snapshots only.
- `finalized_by` (string, optional, nullable) — Display name of the analyst who finalized the spread (`final` and `machine` snapshots); null on drafts and for callers who may not see names.
- `finalized_by_external_user_id` (string, optional, nullable) — The `external_user_id` your embed session named for the analyst who finalized. It is your own identifier for that user, not a person's name, so it is returned to every caller and a backend can join it to its own user table. Null on drafts, and null when the finalize happened in the SpreadSpace workspace or under an embed session that named no user.

## 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

### 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
{
  "snapshot_id": "8a7b6c5d4e3f2a1b0c9d8e7f",
  "version": 2,
  "status": "final",
  "created_at": "2024-04-10T14:45:02.684432+00:00",
  "payload": {
    "schema_version": "attributes.v1",
    "periods": [
      "2022",
      "2023"
    ],
    "attributes": {
      "tax_return_tax_gross_receipts": {
        "label": "Gross receipts",
        "unit": "money",
        "basis": "tax",
        "values": {
          "2022": "2210500.00",
          "2023": "2450000.00"
        },
        "documents": {
          "2022": [
            {
              "document_id": "7b6a59483726150493827160",
              "extraction_version": 1
            }
          ],
          "2023": [
            {
              "document_id": "123abc456def7890a1b2c3d4",
              "extraction_version": 1
            }
          ]
        }
      },
      "tax_return_tax_ebitda": {
        "label": "EBITDA (tax basis)",
        "unit": "money",
        "basis": "tax",
        "values": {
          "2022": "372800.00",
          "2023": "410250.00"
        },
        "documents": {
          "2022": [
            {
              "document_id": "7b6a59483726150493827160",
              "extraction_version": 1
            }
          ],
          "2023": [
            {
              "document_id": "123abc456def7890a1b2c3d4",
              "extraction_version": 1
            }
          ]
        }
      }
    },
    "ratios": {
      "tax_return_current_ratio": {
        "label": "Current ratio (Schedule L)",
        "unit": "ratio",
        "basis": "tax_return_tax",
        "values": {
          "2022": "1.6120",
          "2023": "1.7345"
        }
      }
    },
    "tables": {},
    "inputs": {
      "addbacks": [
        {
          "label": "Officer compensation",
          "direction": "add",
          "years": [
            "2023"
          ],
          "amount": {
            "2023": "185000.00"
          }
        }
      ],
      "dscr_configs": [
        {
          "name": "Standard DSCR",
          "numerator": "Adjusted EBITDA"
        }
      ],
      "hidden_rows": 0,
      "custom_visuals": 0,
      "custom_tables": 0
    }
  },
  "manifest": {
    "documents": [
      {
        "document_id": "7b6a59483726150493827160",
        "document_type": "1120s",
        "fiscal_year": 2022,
        "period_end": "2022-12-31",
        "extraction_version": 1
      },
      {
        "document_id": "123abc456def7890a1b2c3d4",
        "document_type": "1120s",
        "fiscal_year": 2023,
        "period_end": "2023-12-31",
        "extraction_version": 1
      }
    ],
    "inputs_summary": {
      "addbacks": 1,
      "dscr_configs": 1,
      "hidden_rows": 0,
      "custom_visuals": 0,
      "custom_tables": 0
    },
    "entity": {
      "key": "business:acme corporation",
      "name": "Acme Corporation"
    },
    "built_at": "2024-04-10T14:45:00Z",
    "builder_version": "8cb1de79f"
  },
  "spread_board_id": "0c9d8e7f6a5b4c3d2e1f0a9b",
  "finalized_at": "2024-04-10T14:45:02.684432+00:00",
  "finalized_by": "Avery Morgan",
  "finalized_by_external_user_id": null
}
```

**SDK Code**

```python
import requests

url = "https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/attributes/8a7b6c5d4e3f2a1b0c9d8e7f"

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

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

print(response.json())
```

```javascript
const url = 'https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/attributes/8a7b6c5d4e3f2a1b0c9d8e7f';
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/loans/9f8b7c6d5e4a3b2c1d0e4f5a/attributes/8a7b6c5d4e3f2a1b0c9d8e7f"

	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/loans/9f8b7c6d5e4a3b2c1d0e4f5a/attributes/8a7b6c5d4e3f2a1b0c9d8e7f")

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/loans/9f8b7c6d5e4a3b2c1d0e4f5a/attributes/8a7b6c5d4e3f2a1b0c9d8e7f")
  .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/loans/9f8b7c6d5e4a3b2c1d0e4f5a/attributes/8a7b6c5d4e3f2a1b0c9d8e7f', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.spreadspace.app/api/loans/9f8b7c6d5e4a3b2c1d0e4f5a/attributes/8a7b6c5d4e3f2a1b0c9d8e7f");
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/loans/9f8b7c6d5e4a3b2c1d0e4f5a/attributes/8a7b6c5d4e3f2a1b0c9d8e7f")! 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()
```