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",
        "createdAt": "2026-07-03T10:30:00.000Z",
        "updatedAt": "2026-07-03T10:45:00.000Z"
      }
    ],
    "meta": {
      "totalItems": 1,
      "itemsPerPage": 20,
      "totalPages": 1,
      "currentPage": 1
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

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

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

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

Read only Returns every workflow in your workspace, paginated and sorted by creation date (newest first). Each entry includes the workflow’s id, display name, current status (active, paused, cancelled, or draft), enrolled-lead count, and creation timestamp. 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 and lead counts.
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.

For the full structural detail of a single workflow (nodes, edges, configuration), call Get Workflow Details and the related list endpoints.

Query parameters

Parameter	Description
`page`	Page number, starting from 1.
`limit`	Results per page (max 100, default 20).
`status`	Filter by workflow status (`active`, `paused`, `cancelled`, `draft`).

Errors

403 Forbidden is returned when the API key cannot read workflows on this workspace.

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

sortOrder

enum<string>

Available options:

ASC,

DESC

sortBy

string

Example:

"createdAt"

limit

number

Example:

20

page

number

Example:

1

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",
        "createdAt": "2026-07-03T10:30:00.000Z",
        "updatedAt": "2026-07-03T10:45:00.000Z"
      }
    ],
    "meta": {
      "totalItems": 1,
      "itemsPerPage": 20,
      "totalPages": 1,
      "currentPage": 1
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

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

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

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

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