Skip to main content
GET
/
campaign-list
List campaigns
curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/campaign-list \
  --header 'token: <token>'
{
  "datalist": [
    {
      "id": 123,
      "campaign_name": "<string>",
      "is_published": 123,
      "agent_name": "<string>",
      "start_end_date": "<string>",
      "max_retry": 123,
      "progress": "<string>",
      "campaign_status_name": "<string>",
      "campaign_status": "<string>",
      "last_updated": "<string>"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "totalPages": 123,
    "currentPage": 123,
    "limit": 123
  }
}
Use this endpoint to retrieve a paginated list of campaigns with optional filters.

​
Endpoint

GET /campaign-list Authentication: Required (workspace auth)

​
Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number (default: 1)
limitnumberNoRecords per page (default: 10)
agent_idnumber | arrayNoFilter by agent ID(s)
campaign_namestringNoPartial name search (LIKE)
campaign_statusstringNoFilter by status. Valid values: draft, inprogress, hold, pause, force_completed, deleted. Defaults to all except deleted.

​
Campaign Status Values

StatusDescription
draftCampaign is in draft mode
inprogressCampaign is actively running
holdCampaign is on hold
pauseCampaign is paused
force_completedCampaign was force completed
deletedCampaign has been deleted

​
Response

{
  "datalist": [
    {
      "id": 42,
      "campaign_name": "Winter Sale Campaign",
      "agent_name": "Sales Agent",
      "start_end_date": "1 Dec - 31 Dec",
      "max_retry": 3,
      "max_delay": "5m - 30m",
      "progress": "120/500",
      "campaign_status_name": "Inprogress",
      "campaign_status": "inprogress",
      "last_updated": "2 days ago"
    }
  ],
  "pagination": {
    "totalRecords": 25,
    "totalPages": 3,
    "currentPage": 1,
    "limit": 10
  }
}

​
Notes

  • campaign_status defaults to all statuses except deleted.
  • A campaign is automatically labeled Completed if its end_date has passed.
  • progress is formatted as called/total audience count.

​
Example cURL

curl -X GET "https://www.tryunleashx.com/api/v1/global/campaign-list?page=1&limit=10&campaign_status=inprogress" \
  -H "token: <api_key>"

Headers

​
token
string
required

API token for authentication

Query Parameters

​
page
integer

Page number (default: 1)

​
limit
integer

Records per page (default: 10)

​
agent_id
integer

Filter by agent ID

​
campaign_name
string

Partial name search (LIKE)

​
campaign_status
enum<string>

Filter by status. Defaults to all except deleted.

Available options:
draft,
inprogress,
hold,
pause,
force_completed,
deleted

Response

Campaign list retrieved successfully

​
datalist
object[]
​
pagination
object