Skip to main content
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>'
{
  "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

ParameterTypeRequiredDescription
campaign_idnumberYesID 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

TypeDescription
1File (PDF, document) — URL is an AWS S3 link
2Link (web URL)

​
Example cURL

curl -X GET "https://www.tryunleashx.com/api/v1/global/campaign-details/42" \
  -H "Authorization: <api_key>"

Headers

​
token
string
required

API token for authentication

Path Parameters

​
campaign_id
integer
required

ID of the campaign

Response

Campaign details retrieved successfully

​
ID
integer
​
AGENT_ID
integer
​
CAMPAIGN_NAME
string
​
START_DATE
string
​
END_DATE
string
​
CAMPAIGN_STATUS
integer
​
CAMPAIGN_STATUS_NAME
string
​
MAX_RETRY
integer
​
MAX_DELAY
object
​
CONDITIONS
object
​
AGENT_NAME
string
​
UPDATED_DATE
string
​
campaign_knowledge_base
object[]
​
link_knowledge_base
object[]