Skip to main content
GET
/
workflows
List workflows
curl --request GET \
  --url https://api.dialnexa.com/v1/workflows \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}
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 and the related list endpoints.

​
Query parameters

ParameterDescription
pagePage number, starting from 1.
limitResults per page (max 100, default 20).
statusFilter by workflow status (active, paused, cancelled, draft).

​
Errors

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

​
Request

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

​
Response

{
  "data": [
    {
      "id": "wfl_m3v7zb9rk2px",
      "name": "30-Day Lead Nurture",
      "status": "active",
      "enrolled_leads": 420,
      "created_at": "2024-04-01T08:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 1 }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:1
​
limit
integer
default:20

Response

200 - application/json

Success.

​
data
object[]
​
meta
object