Get Workflow

Fetch the configuration and current state of a single workflow, including status, lead counts, and structural totals.

GET /workflows/{id}

Get a workflow

cURL

curl --request GET \
  --url https://api.dialnexa.com/v1/workflows/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "wf_abc123",
  "organization_id": "org_xyz",
  "title": "Lead Nurture Sequence",
  "description": "Contacts cold leads three times before marking as unresponsive.",
  "status": "active",
  "created_at": "2024-03-01T09:00:00.000Z",
  "updated_at": "2024-03-02T11:00:00.000Z"
}

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

Parameter	Description
id	The workflow ID, for example wfl_m3v7zb9rk2px.

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.

Request

curl "https://api.dialnexa.com/v1/workflows/wfl_m3v7zb9rk2px" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "id": "wfl_m3v7zb9rk2px",
  "name": "30-Day Lead Nurture",
  "status": "active",
  "node_count": 5,
  "edge_count": 6,
  "enrolled_leads": 420,
  "created_at": "2024-04-01T08:00:00.000Z"
}

Related endpoints

• List Nodes: retrieve the workflow’s node set.
• List Edges: retrieve the transitions between nodes.
• Pause Workflow and Resume Workflow: control the running state.
• List Workflow Leads: see which leads are enrolled.

Authorizations

Authorization · string · header · required

Pass your API key as a Bearer token in the Authorization header.

Path Parameters

id · string · required

Response

200

application/json

Success.

id · string

Example:

"wf_abc123"

organization_id · string

Example:

"org_xyz"

title · string

Example:

"Lead Nurture Sequence"

description · string | null

Example:

"Contacts cold leads three times before marking as unresponsive."

status · enum<string>

Workflow lifecycle status. Responses can include running for older workflow records; treat it like active. Use active in new create or update requests.

Available options: draft, active, running, paused, completed, cancelled

Example:

"active"

created_at · string<date-time>

Example:

"2024-03-01T09:00:00.000Z"

updated_at · string<date-time>

Example:

"2024-03-02T11:00:00.000Z"