# GET /api/v1/firm/capital/overview

> The firm's capital desk

- **Tag:** firm-capital
- **Operation ID:** `get_firm_capital_overview`

## Description

One row per client the caller can see, ranked fundable first: Trust Scorecard grade, data readiness with its blockers, the best listed program the client would qualify for (published limit range and a read-only pre-check of the program's active scorecard over the client's books), existing lines and headroom, and `one_fix_away` when exactly one blocker remains. Totals: clients fundable now and the capital available. No assessment is run and nothing is decided.

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Parameters

- `firm_id` (query, string, optional) — The firm to read; defaults to the caller's staff firm.

## Responses

### 200 — Successful Response

Schema: `SuccessEnvelope_FirmCapitalOverviewResponse_`

- `success` (boolean)
- `message` (string)
- `code` (string)
- `data` (FirmCapitalOverviewResponse)

### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

### 403 — Forbidden - Insufficient permissions

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

### 422 — Validation Error

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

## Code samples

### cURL

```bash
curl -X GET 'https://api.ondayzero.com/api/v1/firm/capital/overview' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/firm/capital/overview', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/firm/capital/overview", headers=headers)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/firm-capital/get-firm-capital-overview
- OpenAPI slice: https://www.ondayzero.com/docs/reference/firm-capital/get-firm-capital-overview/openapi.json
- Other endpoints in **firm-capital**: https://www.ondayzero.com/docs/reference/firm-capital (markdown bundle: https://www.ondayzero.com/docs/reference/firm-capital.md, OpenAPI: https://www.ondayzero.com/docs/reference/firm-capital/openapi.json)
- Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md