# List summary

URL: https://docs.hanzo.ai/docs/openapi/framework/get-framework-summary

> Reports how much of the DocType surface the caller's org uses: how many DocTypes it has defined, and how many documents exist across them.

`GET /v1/framework/summary`

> [Framework →](https://docs.hanzo.ai/docs/openapi/framework) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                             |
| ------------- | ------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/framework/summary` |
| **Method**    | `GET`                                       |
| **Operation** | `get_framework_summary`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`      |

Reports how much of the DocType surface the caller's org uses: how
many DocTypes it has defined, and how many documents exist across them.

## Request

`GET /v1/framework/summary` takes no parameters and no body — the credential is the whole request.

## Response

| Status    | Body                  | Meaning |
| --------- | --------------------- | ------- |
| `200`     | framework.summaryView | ok      |
| `default` | problem-details       | refused |

`200` body — 2 fields.

| Field       | In   | Type            | Always | Description                                        |
| ----------- | ---- | --------------- | ------ | -------------------------------------------------- |
| `doctypes`  | body | integer (int64) | —      | DocTypes is how many DocTypes the org has defined. |
| `documents` | body | integer (int64) | —      | Documents is how many documents exist across them. |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo framework summary
```

**SDK**

**.ts**

```ts
import { Configuration, FrameworkApi } from 'hanzoai';

const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFrameworkSummary();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FrameworkApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FrameworkApi(client).get_framework_summary()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FrameworkAPI.GetFrameworkSummary(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, framework_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = framework_api::get_framework_summary(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FrameworkApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FrameworkApi(client).getFrameworkSummary();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/framework/summary \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `framework`, op `get_framework_summary` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "framework",
         "arguments": {
           "op": "get_framework_summary",
           "input": {}
         }
       }
     }'
```

---

[Framework API](https://docs.hanzo.ai/docs/openapi/framework) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)