Skip to main content
GET
Get Workflow Details
Read only
Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.
Returns the complete record for a single workflow: the display name, description, current status (such as active, paused, or cancelled), the totals of nodes and edges in the graph, the enrolled-lead count, and creation/update timestamps. This endpoint does not return the nodes or edges themselves, fetch those separately through List Nodes and List Edges when you need the full graph structure.

When to use this

  • Workflow dashboards: render the workflow’s header summary (name, status, lead count) before lazy-loading the graph.
  • Pre-update checks: confirm the workflow status is paused or inactive before applying structural edits.
  • Reporting: pull live counts of enrolled leads alongside historical call logs from List Call Logs.
To enumerate every workflow on the workspace, use List Workflows.

Path parameters

Errors

  • 404 Not Found is returned when the workflow does not exist or has been deleted.
  • 403 Forbidden is returned when the API key cannot read workflows on this workspace.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Workflow ID

Example:

"workflow_abc123"

Response

Workflow fetched successfully.

statusCode
number
Example:

200

message
string
Example:

"Workflow fetched successfully"

data
object