Skip to main content
GET
Get a workflow
Returns a simplified view of the workflow graph. Each node includes its typeName, outgoing connections in nextNodeIds, and selected display fields. Use Get a workflow node to retrieve full details for a single node.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflowId
string
required

The ID of the workflow.

Example:

"clw1a3b5c7d9e1f3g5h7i9j1"

Response

Successful.

id
string
required

The ID of the workflow.

workflowRevisionId
string | null
required

The current workflow revision token. Pass the latest value as expectedRevisionId on the next workflow mutation. Will be null for workflows without a revision token yet.

status
enum<string>
required
Available options:
Draft,
Sending,
Paused,
PausedAndQueueing
mailingListId
string | null
required

The ID of the mailing list the workflow sends to.

rootNodeId
string
required

The ID of the root node in the workflow graph.

nodes
object
required

A map of node IDs to simplified node objects. Each node includes typeName and nextNodeIds, plus type-specific fields when present. To get the full node object, use the GET /v1/workflows/{workflowId}/nodes/{nodeId} endpoint.

Example:
name
string

The name of the workflow.

description
string

The description of the workflow.

Last modified on July 20, 2026