Skip to main content
GET

Overview

Returns one workflow’s full definition: trigger, steps, edges, and run metadata. Get the id from List workflows.

Authentication

Requires an API key in the Authorization header.

Request

string
required
The workflow’s UUID. The route matches a UUID only - a non-UUID id returns 404.

Example request

Response

string
The workflow’s UUID.
string
The owning user’s UUID.
string
Display name.
string
Human-readable description. Omitted when empty.
string
active, paused, draft, or archived.
object
Trigger configuration. type is one of manual, webhook, schedule, file_upload, or monitor_event.
object[]
The step definitions, in order. Step config uses {{trigger.<field>}} and {{steps.<n>.result.<path>}} templating.
object[]
Connections between steps. Omitted when the workflow is linear.
string
The template this workflow was created from. Omitted when none.
integer
Total number of runs.
string
ISO 8601 timestamp of the most recent run. Omitted when never run.
string
ISO 8601 creation timestamp.
string
ISO 8601 last-update timestamp.
There is no version field on the workflow object. Version history is dashboard-only.

Errors

Next steps