Skip to main content
GET
Get Workflow Details
Read only Returns the stored record for a single workflow: its id, title, description, current status (draft, active, paused, completed or cancelled), fallback_variables, organization_id, is_deleted, and the createdAt and updatedAt timestamps. It does not return the node and edge definitions, counts of them, or the number of enrolled leads. Open the workflow in the dashboard when you need the full graph structure, and use List Workflow Leads for the leads.

When to use this

  • Workflow dashboards: render the workflow’s header summary (title, status) before lazy-loading the graph.
  • Pre-update checks: confirm the workflow status is draft or paused before applying structural edits in the dashboard.
  • Reporting: combine this record with List Workflow Leads for lead counts and compare them with Call History.
To enumerate every workflow on the workspace, use List Workflows.

Path parameters

Errors

  • 404 Not Found is returned when the workflow does not exist in this workspace or has been deleted. A workflow that belongs to another workspace is reported the same way.
  • 401 Unauthorized is returned when the API key is missing or invalid.

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.

success
enum<boolean>
required
Available options:
true
error
enum<boolean>
required
Available options:
false
statusCode
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required
timestamp
string<date-time>
required