Hanzo
OpenapiFramework

Returns every DocType defined in the caller's org.

Returns every DocType defined in the caller's org.

GET /v1/framework/doctypes

Addresshttps://api.hanzo.ai/v1/framework/doctypes
MethodGET
Operationget_framework_doctypes
AuthAuthorization: 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

StatusBodyMeaning
200docTypeListok

200 body — 29 fields.

FieldInTypeAlwaysDescription
databodyDocType[]Data is every DocType defined in the caller's org.
data[].autonamebodystring
data[].createdAtbodyinteger
data[].fieldsbodyDocField[]
data[].fields[].defaultbodystring
data[].fields[].fetchFrombodystring
data[].fields[].fieldnamebodystring
data[].fields[].fieldtypebodystring
data[].fields[].hiddenbodyboolean
data[].fields[].inListViewbodyboolean
data[].fields[].labelbodystring
data[].fields[].optionsbodystring
data[].fields[].readOnlybodyboolean
data[].fields[].reqdbodyboolean
data[].fields[].uniquebodyboolean
data[].isSinglebodyboolean
data[].isSubmittablebodyboolean
data[].modulebodystring
data[].namebodystring
data[].permissionsbodyDocPerm[]
data[].permissions[].cancelbodyboolean
data[].permissions[].createbodyboolean
data[].permissions[].deletebodyboolean
data[].permissions[].readbodyboolean
data[].permissions[].rolebodystring
data[].permissions[].submitbodyboolean
data[].permissions[].writebodyboolean
data[].titleFieldbodystring
data[].updatedAtbodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo framework doctypes list

Framework API · All Hanzo APIs · Interactive reference

How is this guide?

On this page