Get Workflow Details

GET

workflows

{id}

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/workflows/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/workflows/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/workflows/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/workflows/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "statusCode": 200,
  "message": "Workflow fetched successfully",
  "data": {
    "id": "workflow_abc123",
    "title": "Q3 Outreach Workflow",
    "status": "active",
    "description": "Automated follow-up sequence",
    "createdAt": "2026-07-03T10:30:00.000Z",
    "updatedAt": "2026-07-03T10:45:00.000Z"
  }
}

{
  "statusCode": 400,
  "message": "Workflow validation failed",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Workflow not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Read only 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 node and edge definitions. Open the workflow in the dashboard 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 and compare them with Call History.

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.

Update Workflow Status: activate, pause, deactivate, or resume the workflow.
List Workflow Leads: see which leads are enrolled.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Workflow ID

Example:

"workflow_abc123"

Response

Workflow fetched successfully.

statusCode

number

Example:

200

message

string

Example:

"Workflow fetched successfully"

data

object

Show child attributes

Get Workflow Details

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/workflows/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/workflows/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/workflows/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/workflows/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "statusCode": 200,
  "message": "Workflow fetched successfully",
  "data": {
    "id": "workflow_abc123",
    "title": "Q3 Outreach Workflow",
    "status": "active",
    "description": "Automated follow-up sequence",
    "createdAt": "2026-07-03T10:30:00.000Z",
    "updatedAt": "2026-07-03T10:45:00.000Z"
  }
}

{
  "statusCode": 400,
  "message": "Workflow validation failed",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 404,
  "message": "Workflow not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Overview

Endpoints

Code Examples And SDK Status

When to use this

Path parameters

Errors

Authorizations

Path Parameters

Response

​When to use this

​Path parameters

​Errors

​Related endpoints

Authorizations

Path Parameters

Response

When to use this

Path parameters

Errors

Related endpoints