Get raw workflow
GET
Get raw workflow

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

workflowID
string
required

Query Parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

blockIDs
string[]

Read only these blocks, or the Start step ID, with their steps and the actions on their exits, as an array: ["blk_1", "blk_2"]. Leave it out to read every node.

Response

200 - application/json

Returns the workflow's ID, name and canvas ID, the stored nodes by ID with rich text rendered as strings, and any requested block IDs that matched no block.

workflow
object
required
nodes
object
required

The stored nodes by ID: blocks, steps, the Start and action lists. A block lists its step IDs in data.steps, and ports keep their targets in data.portsV2. Text the canvas stores as rich text reads as a string, with {name} for a variable, entity or secret and name for a tool, playbook or workflow. Every other field is exactly as stored, and its shape can change without notice.

missingBlockIDs
string[]

IDs in blockIDs that name no block or Start in this workflow.

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.