Hanzo
OpenapiFramework

Returns one DocType definition — its fields, naming rule, permissions and…

Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags.

GET /v1/framework/doctypes/{name}

Addresshttps://api.hanzo.ai/v1/framework/doctypes/{name}
MethodGET
Operationget_framework_doctypes_by_name
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one DocType definition — its fields, naming rule, permissions and lifecycle flags. Scoped to the caller's org, so another tenant's DocType of the same name is simply not found.

Request

1 field.

FieldInTypeRequiredDescription
namepathstringyesName is the DocType's name, from the path.

Response

StatusBodyMeaning
200DocTypeok

200 body — 28 fields.

FieldInTypeAlwaysDescription
autonamebodystring
createdAtbodyinteger
fieldsbodyDocField[]
fields[].defaultbodystring
fields[].fetchFrombodystring
fields[].fieldnamebodystring
fields[].fieldtypebodystring
fields[].hiddenbodyboolean
fields[].inListViewbodyboolean
fields[].labelbodystring
fields[].optionsbodystring
fields[].readOnlybodyboolean
fields[].reqdbodyboolean
fields[].uniquebodyboolean
isSinglebodyboolean
isSubmittablebodyboolean
modulebodystring
namebodystring
permissionsbodyDocPerm[]
permissions[].cancelbodyboolean
permissions[].createbodyboolean
permissions[].deletebodyboolean
permissions[].readbodyboolean
permissions[].rolebodystring
permissions[].submitbodyboolean
permissions[].writebodyboolean
titleFieldbodystring
updatedAtbodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo framework doctypes get <name>

Framework API · All Hanzo APIs · Interactive reference

How is this guide?

On this page