Skip to main content
GET
Get Workflow V2
Integration Prompt for AI Agents
Use this to load the full graph (definition) for editing or execution setup. Interpret nodes/edges using the discriminated OpenAPI types so single vs options vs start and each data variant deserialize correctly.

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

workflow_id
string<uuid>
required

Response

Successful Response

Single workflows_v2 row.

id
string
required

Workflow ID

name
string
required

Name of the workflow

definition
Definition · object
required

Stored React Flow graph (start / single / options nodes). Nodes and edges use top-level string id fields; edge id values are unique within the graph.

created_at
string<date-time>
required

Creation timestamp

organization_id
string | null

Owning organization ID (set by middleware on create)

agent_ids
integer[]

Linked agent ids when the workflow is agent-scoped

description
string | null

Description

dh_sync_summary
Dh Sync Summary · object | null

Present on PUT responses when the definition was updated. Keys: updated, created, marked_stale, skipped, errors.

warnings
string[]

Non-blocking lint warnings emitted at save time (e.g. node text referencing an unknown {{trait_name}}). Empty when the definition is clean or no agents are linked.