Campaign details
curl --request GET \
--url https://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id} \
--header 'token: <token>'import requests
url = "https://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id}"
headers = {"token": "<token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<token>'}};
fetch('https://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_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://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_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 => [
"token: <token>"
],
]);
$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://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<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://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id}")
.header("token", "<token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<token>'
response = http.request(request)
puts response.read_body{
"ID": 123,
"AGENT_ID": 123,
"CAMPAIGN_NAME": "<string>",
"START_DATE": "<string>",
"END_DATE": "<string>",
"CAMPAIGN_STATUS": 123,
"CAMPAIGN_STATUS_NAME": "<string>",
"MAX_RETRY": 123,
"MAX_DELAY": {},
"CONDITIONS": {},
"AGENT_NAME": "<string>",
"UPDATED_DATE": "<string>",
"campaign_knowledge_base": [
{}
],
"link_knowledge_base": [
{}
]
}Campaigns
Campaign Details
Retrieve full details of a specific campaign including knowledge base items.
GET
/
campaign-details
/
{campaign_id}
Campaign details
curl --request GET \
--url https://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id} \
--header 'token: <token>'import requests
url = "https://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id}"
headers = {"token": "<token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<token>'}};
fetch('https://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_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://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_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 => [
"token: <token>"
],
]);
$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://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<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://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id}")
.header("token", "<token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.tryunleashx.com/api/v1/global/campaign-details/{campaign_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<token>'
response = http.request(request)
puts response.read_body{
"ID": 123,
"AGENT_ID": 123,
"CAMPAIGN_NAME": "<string>",
"START_DATE": "<string>",
"END_DATE": "<string>",
"CAMPAIGN_STATUS": 123,
"CAMPAIGN_STATUS_NAME": "<string>",
"MAX_RETRY": 123,
"MAX_DELAY": {},
"CONDITIONS": {},
"AGENT_NAME": "<string>",
"UPDATED_DATE": "<string>",
"campaign_knowledge_base": [
{}
],
"link_knowledge_base": [
{}
]
}Use this endpoint to retrieve full details of a specific campaign, including its knowledge base items.
Endpoint
GET/campaign-details/:campaign_id
Authentication: Required (workspace auth)
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | number | Yes | ID of the campaign |
Response
{
"ID": 42,
"AGENT_ID": 123,
"CAMPAIGN_NAME": "Winter Sale Campaign",
"START_DATE": "1 Dec, 2025",
"END_DATE": "31 Dec, 2025",
"CAMPAIGN_STATUS": 1,
"CAMPAIGN_STATUS_NAME": "Inprogress",
"MAX_RETRY": 3,
"MAX_DELAY": {
"min": 5,
"max": 30,
"unit": "minutes"
},
"CONDITIONS": {
"max_daily_calls": 500,
"time_window": {
"start": "09:00",
"end": "18:00",
"timezone": "America/New_York"
}
},
"AGENT_NAME": "Sales Agent",
"UPDATED_DATE": "2 days ago",
"campaign_knowledge_base": [
{
"ID": 1,
"KNOWLEDGEBASE_NAME": "faq.pdf",
"KNOWLEDGEBASE_TYPE": 1,
"KNOWLEDGEBASE_LOCATION": "https://your-bucket.s3.amazonaws.com/faq.pdf"
}
],
"link_knowledge_base": [
{
"ID": 2,
"KNOWLEDGEBASE_NAME": "Support Articles",
"KNOWLEDGEBASE_TYPE": 2,
"KNOWLEDGEBASE_LOCATION": "https://docs.yourdomain.com/support"
}
]
}
Knowledge Base Types
| Type | Description |
|---|---|
1 | File (PDF, document) — URL is an AWS S3 link |
2 | Link (web URL) |
Example cURL
curl -X GET "https://www.tryunleashx.com/api/v1/global/campaign-details/42" \
-H "Authorization: <api_key>"
Headers
API token for authentication
Path Parameters
ID of the campaign
Response
Campaign details retrieved successfully
Was this page helpful?
⌘I

