> 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 current user

GET https://api.spreadspace.app/api/me

Retrieves the caller's identity and the organization the credential belongs to. For an API key, `email` is null and `display_name` is the key's name. Embed sessions cannot call it (403).

Requires no scope: any key in the workspace can call it. Rate limit: 200 requests per minute per key (the `api` lane).

Reference: https://docs.spreadspace.app/api/api-reference/me/get-me

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

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

- `caller_type` (string, required)
- `id` (string, required)
- `organization` (MeOrganizationContext, required, nullable)
- `api_key` (MeApiKeyContext, required, nullable) — The calling API key's identity block on `GET /api/me`. Only what the key holder already knows or needs to identify the key: never its secret, its IP allowlist, or its usage counters.
- `email` (string, optional, nullable)
- `display_name` (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.

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

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

### MeOrganizationContext

- `id` (string, required)
- `name` (string, required)
- `tier` (string, required)
- `workspace_mode` (string, required) — `sandbox` for a trial workspace with seed data, `live` once activated.
- `practice` (string, required) — `credit` (borrowers and loans) or `transactions` (companies and deals); the workspace's vocabulary. Default credit, so an older payload reads as today's UI.
- `intake_available` (boolean, required)
- `counterparty_available` (boolean, required)
- `spreads_available` (boolean, required)

### MeApiKeyContext

The calling API key's identity block on `GET /api/me`. Only what the key holder already knows or needs to identify the key: never its secret, its IP allowlist, or its usage counters.

- `id` (string, required)
- `name` (string, required)
- `tags` (list of string, required)
- `mode` (string, required)
- `scopes` (list of string, required)
- `description` (string, optional, nullable)
- `key_prefix` (string, optional, nullable)
- `last4` (string, optional, nullable)
- `template` (string, optional, nullable)
- `service_account_name` (string, optional, nullable)
- `pinned_api_version` (string, optional, nullable)
- `expires_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.

## Examples

**Response**

```json
{
  "caller_type": "service_account",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "organization": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Greenfield Lending Co.",
    "tier": "enterprise",
    "workspace_mode": "live",
    "practice": "credit",
    "intake_available": true,
    "counterparty_available": true,
    "spreads_available": true
  },
  "api_key": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "name": "Production integration key",
    "tags": [],
    "mode": "live",
    "scopes": [
      "documents:read",
      "documents:write",
      "loans:read",
      "jobs:read",
      "extractions:read",
      "extractions:export"
    ],
    "description": null,
    "key_prefix": "ss_live_a1b",
    "last4": "9x4q",
    "template": null,
    "service_account_name": "Loan origination integration",
    "pinned_api_version": "2026-05-03",
    "expires_at": null
  },
  "email": null,
  "display_name": "Loan origination integration"
}
```

**SDK Code**

```python
import requests

url = "https://api.spreadspace.app/api/me"

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

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

print(response.json())
```

```javascript
const url = 'https://api.spreadspace.app/api/me';
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/me"

	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/me")

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/me")
  .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/me', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.spreadspace.app/api/me");
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/me")! 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()
```