Get a workflow

GET/v1/workflows/{id}

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

Includes stepStats: per-node counts grouped by outcome.

Path parameters

idstringrequired
Workflow id.

Response

The workflow with aggregates.

workflowIdstringrequired
projectIdstring
namestringrequired
statusenumrequired
draftactivepaused
triggerstringrequired
`event:<name>`, `contact.created`, `segment:enter:<ref>`, or `segment:exit:<ref>`.
graphobject | null
reentryenumrequired
neverafter_exitalways
enteredinteger
completedinteger
activeinteger
createdAtdate-timerequired
stepStatsobject[]
- nodeIdstring
- nodeTypestring
- outcomestring
- countinteger

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

401Missing or invalid API key.
404Not found.
422Request validation failed (code `validation_error`, 422).

Request

curl https://api.volanea.com/v1/workflows/id_123 \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "workflowId": "wf_7d31",
    "projectId": "<projectId>",
    "name": "Welcome",
    "status": "draft",
    "trigger": "<trigger>",
    "graph": {
      "nodes": [
        {
          "id": null,
          "type": null,
          "label": null,
          "config": null,
          "x": null,
          "y": null
        }
      ],
      "edges": [
        {
          "from": null,
          "to": null,
          "label": null
        }
      ]
    },
    "reentry": "never",
    "entered": 1,
    "completed": 1,
    "active": 1,
    "createdAt": "2026-01-01T09:00:00.000Z",
    "stepStats": [
      {
        "nodeId": "<nodeId>",
        "nodeType": "<nodeType>",
        "outcome": "<outcome>",
        "count": 1
      }
    ]
  }
}

92 endpoints · OpenAPI document