# Get framework — GET /v1/framework/{doctype}

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

> Returns the caller org's documents of one DocType, filtered, ordered and projected by the query.

`GET /v1/framework/{doctype}`

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

Returns the caller org's documents of one DocType, filtered,
ordered and projected by the query. The DocType is resolved FIRST — through
the same permission gate the list itself uses — because the query is validated
against its schema: a filter, sort or field name the DocType does not declare
is refused rather than reaching the store.

## Request

5 fields.

| Field      | In    | Type   | Required | Description                                                                               |
| ---------- | ----- | ------ | -------- | ----------------------------------------------------------------------------------------- |
| `doctype`  | path  | string | yes      | DocType is the DocType to list, by ADDRESS — "module.name", from the path.                |
| `filters`  | query | string | —        | Filters is a JSON object of equality matches, e.g. {"priority":"High"}.                   |
| `fields`   | query | string | —        | Fields projects the response to a subset — a JSON array \["a","b"] or a comma list "a,b". |
| `order_by` | query | string | —        | OrderBy is "\<field> \[asc\|desc]".                                                       |
| `limit`    | query | string | —        | Limit caps the rows returned.                                                             |

## Response

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

`200` body — 2 fields.

| Field      | In   | Type      | Always | Description                                                                                                                                          |
| ---------- | ---- | --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data`     | body | object\[] | —      | Data is the matching documents, newest-updated first unless order\_by said otherwise, each projected to the requested fields plus the envelope keys. |
| `data[].*` | body | any       | —      |                                                                                                                                                      |

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

## Examples

**CLI**

```bash
hanzo framework get <doctype>
```

**SDK**

**.ts**

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

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

**.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_by_doctype(doctype='doctype')
```

**.go**

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

resp, _, err := client.FrameworkAPI.GetFrameworkByDoctype(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_by_doctype(&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).getFrameworkByDoctype();
```

**HTTP**

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

**MCP**

Tool `framework`, op `get_framework_by_doctype` — 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_by_doctype",
           "input": {
             "doctype": "<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)