Skip to main content
GET
/
campaigns
List campaigns
curl --request GET \
  --url https://api.dialnexa.com/v1/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cmp_xyz789",
      "organization_id": "org_xyz",
      "name": "Q2 Lead Re-engagement",
      "agent_id": "agt_abc123",
      "from_phone_number": "+912234567890",
      "status": "running",
      "max_concurrent_calls": 5,
      "scheduled_at": null,
      "retry_config": {
        "max_retries": 3,
        "retry_interval_minutes": 120
      },
      "created_at": "2024-03-01T09:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}
Returns every calling campaign in your workspace, paginated and sorted by creation date (newest first). Each entry includes the campaign’s id, display name, current status (active, paused, completed, cancelled), totals of total_leads and completed_calls, and the creation timestamp. Use this to power a campaigns overview dashboard, sync campaign state into your own database, or build reporting that watches the pipeline of running outreach.

​
When to use this

  • Campaign dashboards: render a table of every campaign with status badges and progress bars.
  • Compliance audits: enumerate every campaign that has run during a given period.
  • Operational monitoring: detect campaigns that have stalled (long gap between created and last call) and flag them for review.
  • Reporting pipelines: sync campaign metadata into a data warehouse alongside per-call logs.
For the configuration and progress of a single campaign, use Get Campaign.

​
Query parameters

ParameterDescription
pagePage number, starting from 1.
limitResults per page (max 100, default 20).
statusFilter by campaign status (active, paused, completed, cancelled).
searchFilter by name (partial match).

​
Errors

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

​
Request

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

​
Response

{
  "data": [
    {
      "id": "cmp_5tw8vz2rnx1q",
      "name": "Q2 Lead Re-engagement",
      "status": "active",
      "total_leads": 1200,
      "completed_calls": 438,
      "created_at": "2024-05-01T09:00:00.000Z"
    },
    {
      "id": "cmp_n3h7kd9qpw4m",
      "name": "New User Onboarding",
      "status": "completed",
      "total_leads": 300,
      "completed_calls": 300,
      "created_at": "2024-04-15T08:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 2 }
}

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