# List modules

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

> Returns every app lane compiled into this deployment and the DocTypes each one installs.

`GET /v1/framework/modules`

> [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/modules` |
| **Method**    | `GET`                                       |
| **Operation** | `get_framework_modules`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`      |

Returns every app lane compiled into this deployment and the
DocTypes each one installs. It describes the BINARY, not the org: what a given
org has actually installed is the per-module state below.

## Request

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

## Response

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

`200` body — 4 fields.

| Field             | In   | Type                | Always | Description                                                                                                                  |
| ----------------- | ---- | ------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------- |
| `data`            | body | framework.module\[] | —      | Data is every module compiled into this binary, with the DocTypes it installs and whether the caller's org has turned it on. |
| `data[].doctypes` | body | string\[]           | —      |                                                                                                                              |
| `data[].enabled`  | body | boolean             | —      | Enabled is whether this org has turned the module on.                                                                        |
| `data[].module`   | body | string              | —      |                                                                                                                              |

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

## Examples

**CLI**

```bash
hanzo framework modules list
```

**SDK**

**.ts**

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

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

**.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_modules()
```

**.go**

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

resp, _, err := client.FrameworkAPI.GetFrameworkModules(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_modules(&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).getFrameworkModules();
```

**HTTP**

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

**MCP**

MCP reaches **framework** through the `framework` tool, which names its 14 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

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

---

[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)