Hanzo
OpenapiFramework

Returns one app lane's install state for the caller's org: the DocTypes the…

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}

Addresshttps://api.hanzo.ai/v1/framework/modules/{module}
MethodGET
Operationget_framework_modules_by_module
AuthAuthorization: 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.

FieldInTypeRequiredDescription
modulepathstringyesModule is the lane's registered name ("cms", "erp"), from the path.

Response

StatusBodyMeaning
200ModuleStateok

200 body — 3 fields.

FieldInTypeAlwaysDescription
doctypesbodystring[]
installedbodystring[]
modulebodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo framework modules get <module>

Framework API · All Hanzo APIs · Interactive reference

How is this guide?

On this page