List Workflows

GET

workflows

List Workflows

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

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

fetch('https://api.dialnexa.com/v1/workflows', 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",
  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"

	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")

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

{
  "success": true,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "statusCode": 200,
    "message": "Workflows fetched successfully",
    "data": [
      {
        "id": "workflow_abc123",
        "title": "Q3 Outreach Workflow",
        "status": "active",
        "description": "Automated follow-up sequence",
        "organization_id": "o14XKPP84rt22g",
        "is_deleted": false,
        "fallback_variables": [],
        "createdAt": "2026-07-03T10:30:00.000Z",
        "updatedAt": "2026-07-03T10:45:00.000Z"
      }
    ],
    "meta": {
      "totalItems": 1,
      "itemsPerPage": 10,
      "totalPages": 1,
      "currentPage": 1
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

{
  "statusCode": 400,
  "error": true,
  "success": false,
  "data": [],
  "message": "sortBy must be one of the following values: created_at, updated_at, createdAt, updatedAt, title, status, id",
  "errors": [
    "sortBy must be one of the following values: created_at, updated_at, createdAt, updatedAt, title, status, id"
  ]
}

{
  "statusCode": 401,
  "error": true,
  "success": false,
  "data": [],
  "message": "Invalid API key",
  "errors": []
}

{
  "statusCode": 500,
  "error": true,
  "success": false,
  "data": [],
  "message": "Error fetching workflows: Internal server error",
  "errors": []
}

Read only Returns every workflow in your workspace, paginated and sorted by creation date (newest first). Each entry includes the workflow’s id, title, description, current status (draft, active, paused, completed or cancelled), fallback_variables, organization_id, is_deleted, and the createdAt and updatedAt timestamps. The response carries the page in data.data and pagination in data.meta. Lead counts are not included; use List Workflow Leads per workflow. Use this to power a workflows overview dashboard, build automation that audits which sequences are running, or sync workflow state into your own data store.

When to use this

Operations dashboards: render a table of every workflow with status badges.
Compliance audits: enumerate all active sequences so legal and compliance teams can confirm what outreach is currently running.
CI integration tests: assert that newly created workflows show up in the list before chaining additional API calls.

To read one workflow by ID, call Get Workflow Details. The workflow endpoints do not return nodes, edges or node configuration; Lead History returns every node (with its configuration) and edge alongside one lead’s path, and the DialNexa dashboard shows the full graph.

Query parameters

Parameter	Description
`page`	Page number, starting from 1.
`limit`	Results per page. Minimum `1`. Default: `10`.
`sortBy`	Field to sort by. One of `created_at`, `updated_at`, `createdAt`, `updatedAt`, `title`, `status`, `id`. Default: `created_at`.
`sortOrder`	Sort direction. One of `ASC`, `DESC`. Default: `DESC`.

Errors

400 Bad Request is returned when page or limit is not a whole number of at least 1, or sortBy or sortOrder is not one of the listed values.
401 Unauthorized is returned when the API key is missing or invalid.

Get Workflow Details: fetch a single workflow’s detail.
Update Workflow Status: activate, pause, deactivate, or resume a workflow.
List Workflow Leads: inspect the leads enrolled in a workflow.
API pagination: how DialNexa list endpoints paginate.

Authorizations

Authorization

string

header

required

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

Query Parameters

page

number

default:1

Page number, starting from 1.

Required range: x >= 1

limit

number

default:10

Results per page.

Required range: x >= 1

sortBy

enum<string>

default:created_at

Field to sort by.

Available options:

created_at,

updated_at,

createdAt,

updatedAt,

title,

status,

id

sortOrder

enum<string>

default:DESC

Sort direction.

Available options:

ASC,

DESC

Response

Workflows 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

Show child attributes

timestamp

string<date-time>

required

List Workflows

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

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

fetch('https://api.dialnexa.com/v1/workflows', 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",
  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"

	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")

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

{
  "success": true,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "statusCode": 200,
    "message": "Workflows fetched successfully",
    "data": [
      {
        "id": "workflow_abc123",
        "title": "Q3 Outreach Workflow",
        "status": "active",
        "description": "Automated follow-up sequence",
        "organization_id": "o14XKPP84rt22g",
        "is_deleted": false,
        "fallback_variables": [],
        "createdAt": "2026-07-03T10:30:00.000Z",
        "updatedAt": "2026-07-03T10:45:00.000Z"
      }
    ],
    "meta": {
      "totalItems": 1,
      "itemsPerPage": 10,
      "totalPages": 1,
      "currentPage": 1
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

{
  "statusCode": 400,
  "error": true,
  "success": false,
  "data": [],
  "message": "sortBy must be one of the following values: created_at, updated_at, createdAt, updatedAt, title, status, id",
  "errors": [
    "sortBy must be one of the following values: created_at, updated_at, createdAt, updatedAt, title, status, id"
  ]
}

{
  "statusCode": 401,
  "error": true,
  "success": false,
  "data": [],
  "message": "Invalid API key",
  "errors": []
}

{
  "statusCode": 500,
  "error": true,
  "success": false,
  "data": [],
  "message": "Error fetching workflows: Internal server error",
  "errors": []
}

Overview

Endpoints

When to use this

Query parameters

Errors

Authorizations

Query Parameters

Response

​When to use this

​Query parameters

​Errors

​Related endpoints

Authorizations

Query Parameters

Response

When to use this

Query parameters

Errors

Related endpoints