Get Workflow Step

Read one step: what it runs, the number the editor shows, and where it sits in the workflow.

GET

Path

Path parameters

stringrequired

The workflow's id, from List Workflows.

stringrequired

The step's id, from List Workflow Steps or Get Workflow Definition.

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Arguments

string

draft (the default), published, or a version label from List Workflow Versions.

draft (the default, what the editor shows), published (what runs), or a version label from List Workflow Versions, such as 0.0.14.

Default: draft

idstring

The step's id. Stable across edits; never positional.

numbernumber

The number the editor shows for this step, in execution order. Null for a folder, which the editor does not number.

namestring

The step's display name.

appSlugstring

The app the step runs, or the built-in step type (iterate, ifElse, map, ...).

appVersionstring

The app version the step is pinned to. "0" for built-in step types.

actionIdstring

The app action the step runs. Null for a built-in step type.

functionIdstring

The function this step calls, for a function call step.

parentStepIdstring

The step this one sits inside (a loop, group, folder or if/else). Null at the top level.

slotstring

Where the step sits in its parent: steps (the top level), body (a loop, group or folder), then or else (an if/else lane).

depthnumber

How deeply the step is nested. 0 at the top level.

isDisabledboolean

True when the step is turned off and runs skip it.

isConfiguredboolean

Whether the step passed the editor's validation (required values set, connection chosen). Null when it was never validated.