Skip to navigation

Flows · Authoring · Read one workflow, optionally with its diagram

View as Markdown

Returns one workflow definition, drafts included.

Pass expand=extra to get the step graph — without it the diagram is omitted. Reading a workflow that already runs is the most reliable way to get a new diagram’s shape right.

resource: workflow://workflows/{id}/diagram returns just the diagram for this purpose.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

workflow_idintegerRequired

Numeric workflow-definition ID. Not a run ID.

Query parameters

expandstringOptional

Comma-separated fields to expand. extra returns the diagram and is the one you usually want. creator, modifier and estimated_credits are also available.

Response

The workflow definition.

Errors

404
Not Found Error