Get Campaign

GET

campaigns

{id}

Get a single campaign by ID

curl --request GET \
  --url https://api.dialnexa.com/campaigns/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-organization-id: <x-organization-id>'

import requests

url = "https://api.dialnexa.com/campaigns/{id}"

headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-organization-id': '<x-organization-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.dialnexa.com/campaigns/{id}', 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/campaigns/{id}",
  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>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$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/campaigns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/campaigns/{id}")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/campaigns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. A public v1 replacement is not currently listed in the v1 reference. This endpoint remains available for existing integrations until then.

Returns the full record for a single campaign - its title, current status, the assigned agent_id and agent_version_number, the scheduling window (starts_at, ends_at, calling_hours_start, calling_hours_end), retry configuration (number_of_retries, interval_between_retries), and lead counts. See the response schema below for the exact fields. Use this endpoint to render campaign detail pages 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

Parameter	Description
`id`	The 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.

List Campaigns: see every campaign on the workspace.
Update Campaign: change concurrency, retry behavior, or pause state.
Get Calls by Campaign: fetch produced call logs.
Rate limits: workspace-level caps that apply to campaign dialling.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-organization-id

string

required

RSA encrypted organization ID (base64 format)

Example:

"BASE64_ENCRYPTED_ORG_ID_HERE"

Path Parameters

string

required

Response

Campaign fetched successfully

Update CampaignUpdate editable campaign settings such as display name, concurrency, and retry behavior. The assigned agent cannot be changed once calling has started.

Get a single campaign by ID

curl --request GET \
  --url https://api.dialnexa.com/campaigns/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-organization-id: <x-organization-id>'

import requests

url = "https://api.dialnexa.com/campaigns/{id}"

headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-organization-id': '<x-organization-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.dialnexa.com/campaigns/{id}', 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/campaigns/{id}",
  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>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$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/campaigns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/campaigns/{id}")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/campaigns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Overview

Endpoints - v1

Endpoints - Legacy

Code Examples And SDK Status

When to use this

Path parameters

Errors

Authorizations

Headers

Path Parameters

Response

​When to use this

​Path parameters

​Errors

​Related endpoints

Authorizations

Headers

Path Parameters

Response

When to use this

Path parameters

Errors

Related endpoints