Get Workflow Definition

GET 
/workflows/:workflowId/definition

Read a workflow as a complete definition. The definition object is accepted verbatim by Update Workflow Definition, so it round-trips.

The definition's version is the workflow's own counter. Leave it as it comes back: sending it unchanged on update is what stops a concurrent edit in the builder from being silently overwritten.

Request

Version stringrequired

API Version

Available optionsv4

workflowId stringrequired

Workflow ID

locationId stringrequired

Sub-account (location) ID the workflow belongs to

application/json

Successful response

application/json

Schema

Schema

workflowIdstringrequired

Workflow ID

statusstringrequired
Whether the workflow is live. Read-only here — change it with Update Workflow Status, which is gated by the workflows.publish scope. It sits outside definition because the definition is sent back verbatim to Update Workflow Definition.
Available optionsdraftpublished
definitionobjectrequired

The definition, in the same shape Update Workflow Definition accepts.

warningsobject[]required

Non-blocking findings

Example (auto)

{
  "workflowId": "b1b0de82-3efb-4d63-83f6-13c50aef208c",
  "status": "draft",
  "definition": {
    "version": 1,
    "name": "Welcome new contacts",
    "source": {
      "system": "api"
    },
    "triggers": [],
    "actions": [],
    "edges": []
  },
  "warnings": [
    {
      "path": "actions[4]",
      "message": "Step has no incoming edges and may be unreachable."
    }
  ]
}