# Get modules

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

> Returns one app lane's install state for the caller's org: the DocTypes the lane declares, and which of them already exist in the org.

`GET /v1/framework/modules/{module}`

> [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/{module}` |
| **Method**    | `GET`                                                |
| **Operation** | `get_framework_modules_by_module`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`               |

Returns one app lane's install state for the caller's org: the
DocTypes the lane declares, and which of them already exist in the org. That
is the honest "set up" versus "installed" answer a console renders.

## Request

1 field.

| Field    | In   | Type   | Required | Description                                                         |
| -------- | ---- | ------ | -------- | ------------------------------------------------------------------- |
| `module` | path | string | yes      | Module is the lane's registered name ("cms", "erp"), from the path. |

## Response

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

`200` body — 3 fields.

| Field       | In   | Type      | Always | Description |
| ----------- | ---- | --------- | ------ | ----------- |
| `doctypes`  | body | string\[] | —      |             |
| `installed` | body | string\[] | —      |             |
| `module`    | body | string    | —      |             |

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

## Examples

**CLI**

```bash
hanzo framework modules get <module>
```

**SDK**

**.ts**

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

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

**.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_by_module(module='module')
```

**.go**

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

resp, _, err := client.FrameworkAPI.GetFrameworkModulesByModule(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_by_module(&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).getFrameworkModulesByModule();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/framework/modules/<module> \
  -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)