> ## Documentation Index
> Fetch the complete documentation index at: https://dialnexa.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List Workflows
> List workflows in your workspace.
Read only
**Recommended.** This endpoint is part of the public `/v1` API reference and is the supported path for new integrations. See the [migration guide](/docs/api-reference/v1/migrating-to-v1) for versioning guidance.
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](/docs/api-reference/v1/workflows/get) 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.
## Related endpoints
* [Get Workflow Details](/docs/api-reference/v1/workflows/get): fetch a single workflow's detail.
* [Update Workflow Status](/docs/api-reference/v1/workflows/status): activate, pause, deactivate, or resume a workflow.
* [List Workflow Leads](/docs/api-reference/v1/workflow-leads/list): inspect the leads enrolled in a workflow.
* [Pagination](/docs/api-reference/pagination): how DialNexa list endpoints paginate.
## OpenAPI
````yaml GET /v1/workflows
openapi: 3.0.0
info:
title: DialNexa API
description: >-
Public REST API for the DialNexa voice AI platform. Versioned endpoints are
under /v1; unversioned endpoints are legacy and deprecated.
version: 1.0.0
servers:
- url: https://api.dialnexa.com
description: DialNexa production API
security:
- bearer: []
tags:
- name: API Keys
- name: Agent Functions
- name: Agents V1
- name: Agents2
- name: Batch Calls
- name: Batch Calls V1
- name: Call Logs
- name: Calls
- name: Calls V1
- name: Campaign Leads
- name: Campaigns
- name: External Webhooks
- name: Knowledge Base
- name: Knowledge Base V1
- name: LLMs
- name: LLMs V1
- name: Languages
- name: Languages V1
- name: Organization Phone Numbers
- name: Organization Phone Numbers V1
- name: Phone Number Pricing
- name: Phone Number Pricing V1
- name: Transcribers
- name: Transcribers V1
- name: User Webhooks
- name: User Webhooks V1
- name: V1
- name: Voices
- name: Voices V1
- name: Webcall
- name: Workflow Leads
- name: Workflow Leads V1
- name: Workflows
- name: Workflows V1
paths:
/v1/workflows:
get:
tags:
- Workflows V1
- V1
summary: List Workflows
description: >-
Returns workflows for the authenticated workspace in a data and meta
pagination envelope.
operationId: WorkflowsV1Controller_findAll
parameters:
- name: sortOrder
required: false
in: query
schema:
enum:
- ASC
- DESC
type: string
- name: sortBy
required: false
in: query
schema:
example: createdAt
type: string
- name: limit
required: false
in: query
schema:
example: 20
type: number
- name: page
required: false
in: query
schema:
type: number
example: 1
responses:
'200':
description: Workflows fetched successfully.
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
example: 200
message:
type: string
example: Workflows fetched successfully
data:
type: array
items:
type: object
properties:
id:
type: string
example: workflow_abc123
title:
type: string
example: Q3 Outreach Workflow
status:
type: string
enum:
- draft
- active
- paused
- completed
- cancelled
example: active
description:
type: string
nullable: true
example: Automated follow-up sequence
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
meta:
type: object
properties:
totalItems:
type: number
example: 50
itemsPerPage:
example: 20
type: number
totalPages:
type: number
example: 3
currentPage:
type: number
example: 1
examples:
success:
summary: Successful response
value:
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
'400':
description: Invalid query parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 400 Bad Request
value:
statusCode: 400
message: Workflow validation failed
error: Bad Request
'401':
description: Unauthorized - missing or invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 401 Unauthorized
value:
statusCode: 401
message: API key is missing or invalid
error: Unauthorized
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 500 Internal Server Error
value:
statusCode: 500
message: Internal server error
error: Internal Server Error
security:
- bearer: []
components:
schemas:
ErrorResponse:
type: object
properties:
statusCode:
type: integer
example: 400
message:
oneOf:
- type: string
- type: array
items:
type: string
example: phone_number must be a valid E.164 phone number
error:
type: string
example: Bad Request
required:
- statusCode
- message
- error
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http
````