Hanzo
OpenapiAuto

Returns one automation and its latest version.

Returns one automation and its latest version.

GET /v1/auto/flows/{id}

Addresshttps://api.hanzo.ai/v1/auto/flows/{id}
MethodGET
Operationget_auto_flows_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one automation and its latest version. That is the flow record plus the step tree the builder edits; a flow of another org answers not-found.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the flow to act on, from the path.

Response

StatusBodyMeaning
200populatedFlowok

200 body — 45 fields.

FieldInTypeAlwaysDescription
createdbodyintegerCreated and Updated are unix milliseconds.
externalIdbodystringExternalID is the caller's own id for this flow, if it set one.
folderIdbodystringFolderID groups the flow in the builder's tree.
idbodystringID is the flow's id.
metadatabodyanyMetadata is the caller's opaque JSON, stored and returned verbatim.
projectIdbodystringOrg is the owning org, which this surface names projectId.
publishedVersionIdbodystringPublishedVersionID is the version a run executes when set; empty means the latest version runs.
statusbodystringStatus is ENABLED or DISABLED — whether the flow's trigger is armed.
updatedbodyinteger
versionbodyFlowVersion
version.createdbodyinteger
version.displayNamebodystring
version.flowIdbodystring
version.idbodystring
version.schemaVersionbodystring
version.statebodystring
version.triggerbodyFlowTrigger
version.trigger.displayNamebodystring
version.trigger.namebodystring
version.trigger.nextActionbodyFlowAction
version.trigger.nextAction.displayNamebodystring
version.trigger.nextAction.namebodystring
version.trigger.nextAction.nextActionbodyFlowAction
version.trigger.nextAction.settingsbodyStepSettings
version.trigger.nextAction.settings.actionNamebodystring
version.trigger.nextAction.settings.inputbodyobject
version.trigger.nextAction.settings.input.*bodyobject
version.trigger.nextAction.settings.pieceNamebodystring
version.trigger.nextAction.settings.pieceVersionbodystring
version.trigger.nextAction.settings.triggerNamebodystring
version.trigger.nextAction.skipbodyboolean
version.trigger.nextAction.typebodystringPIECE | CODE | ROUTER | LOOP_ON_ITEMS
version.trigger.nextAction.validbodyboolean
version.trigger.settingsbodyStepSettings
version.trigger.settings.actionNamebodystring
version.trigger.settings.inputbodyobject
version.trigger.settings.input.*bodyobject
version.trigger.settings.pieceNamebodystring
version.trigger.settings.pieceVersionbodystring
version.trigger.settings.triggerNamebodystring
version.trigger.strategybodystring
version.trigger.typebodystringPIECE_TRIGGER | EMPTY
version.trigger.validbodyboolean
version.updatedbodyinteger
version.validbodyboolean

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Auto API · All Hanzo APIs · Interactive reference

How is this guide?

On this page