Skip to main content
GET
/
campaigns
/
{id}
Get a campaign
curl --request GET \
  --url https://api.dialnexa.com/v1/campaigns/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}
Returns the full record for a single campaign: the display name, the current status (active, paused, completed, cancelled), the assigned agent_id, the outbound from_phone_number, the configured max_concurrent_calls, the total enrolled total_leads, and live progress counters (completed_calls, pending_calls). Use this endpoint to render campaign detail pages, drive progress UIs, and audit how a campaign is configured before changing its state.

​
When to use this

  • Campaign dashboards: render the header summary (name, status, agent, from-number) and progress bar.
  • Pre-update checks: confirm a campaign is paused before changing concurrency or retry rules.
  • Operations runbooks: pull the current pending count to estimate when a campaign will finish at the current concurrency.
For the list of leads inside the campaign, use List Workflow Leads if the campaign was created from a workflow, or query List Call Logs filtered by campaign_id for produced call logs.

​
Path parameters

ParameterDescription
idThe campaign ID, for example cmp_5tw8vz2rnx1q.

​
Errors

  • 404 Not Found is returned when the campaign does not exist.
  • 403 Forbidden is returned when the API key cannot read campaigns on this workspace.

​
Request

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

​
Response

{
  "id": "cmp_5tw8vz2rnx1q",
  "name": "Q2 Lead Re-engagement",
  "status": "active",
  "agent_id": "agt_k7m2nq9xw4p8",
  "from_phone_number": "+912234567890",
  "max_concurrent_calls": 5,
  "total_leads": 1200,
  "completed_calls": 438,
  "pending_calls": 762,
  "created_at": "2024-05-01T09:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

Success.

​
id
string
Example:

"cmp_xyz789"

​
organization_id
string
Example:

"org_xyz"

​
name
string
Example:

"Q2 Lead Re-engagement"

​
agent_id
string
Example:

"agt_abc123"

​
from_phone_number
string
Example:

"+912234567890"

​
status
enum<string>

Batch campaign lifecycle status.

Available options:
draft,
active,
running,
paused,
completed,
cancelled
Example:

"running"

​
max_concurrent_calls
integer
Example:

5

​
scheduled_at
string<date-time> | null
Example:

null

​
retry_config
object
Example:
{
  "max_retries": 3,
  "retry_interval_minutes": 120
}
​
created_at
string<date-time>
Example:

"2024-03-01T09:00:00.000Z"