List doctypes
Returns every DocType defined in the caller's org.
GET /v1/framework/doctypes
| Address | https://api.hanzo.ai/v1/framework/doctypes |
| Method | GET |
| Operation | get_framework_doctypes |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns every DocType defined in the caller's org. Another tenant's definitions are never included: the org is part of the store key.
Request
GET /v1/framework/doctypes takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | framework.docTypeList | ok |
default | problem-details | refused |
200 body — 30 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | framework.DocType[] | — | Data is every DocType defined in the caller's org. |
data[].autoname | body | string | — | |
data[].createdAt | body | integer (int64) | — | |
data[].fields | body | framework.DocField[] | — | |
data[].fields[].default | body | string | — | |
data[].fields[].fetchFrom | body | string | — | |
data[].fields[].fieldname | body | string | — | |
data[].fields[].fieldtype | body | string | — | |
data[].fields[].hidden | body | boolean | — | |
data[].fields[].inListView | body | boolean | — | |
data[].fields[].label | body | string | — | |
data[].fields[].options | body | string | — | |
data[].fields[].readOnly | body | boolean | — | |
data[].fields[].reqd | body | boolean | — | |
data[].fields[].unique | body | boolean | — | |
data[].immutable | body | boolean | — | |
data[].isSingle | body | boolean | — | |
data[].isSubmittable | body | boolean | — | |
data[].module | body | string | — | |
data[].name | body | string | — | |
data[].permissions | body | framework.DocPerm[] | — | |
data[].permissions[].cancel | body | boolean | — | |
data[].permissions[].create | body | boolean | — | |
data[].permissions[].delete | body | boolean | — | |
data[].permissions[].read | body | boolean | — | |
data[].permissions[].role | body | string | — | |
data[].permissions[].submit | body | boolean | — | |
data[].permissions[].write | body | boolean | — | |
data[].titleField | body | string | — | |
data[].updatedAt | body | integer (int64) | — |
Failure carries the platform error shape — see Errors.
Examples
CLI
SDK
HTTP
MCP
hanzo framework doctypes list.ts
.py
.go
.rs
.java
import { Configuration, FrameworkApi } from 'hanzoai';
const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFrameworkDoctypes();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_doctypes()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.FrameworkAPI.GetFrameworkDoctypes(context.Background()).Execute()
if err != nil {
return err
}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_doctypes(&cfg, Default::default()).await?;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).getFrameworkDoctypes();curl https://api.hanzo.ai/v1/framework/doctypes \
-H "Authorization: Bearer $HANZO_API_KEY"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:
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"
}
}
}'Was this page useful?