campaigns

Get a specific campaign by UUID

Retrieves detailed information about a specific outbound call campaign, including its full configuration (name, max retry, start date, script), assigned users and groups, contact queue statistics, and associated tags. The campaign is identified by its UUID.

Permission: No specific permission required. A valid API key is sufficient.

get/campaigns/call/{campaignscalllistuuid}

Path parameters

campaignscalllistuuidstring uuid required

The UUID of the campaign (e.g., 1a7a5639-3818-4b0e-9285-f6b3795f8db4). Use GET /campaigns/call to discover campaign UUIDs.

Response

Successful operation

campaign_calllist_uuidstring uuid

Unique identifier for the object

team_idinteger

Team identifier

user_idinteger

User identifier

namestring

The name of the campaign CALL List

campaign_tagsinteger[]

tags of the campaign

users_listinteger[]

The list of users

groups_listinteger[]

The list of groups

fifo_left_to_callinteger

The number of numbers left to call

update_datestring date-time

creation_datestring date-time

deletion_datestring date-time

max_retryinteger

The max retry attempts for numbers in the campaign CALL List

retry_timeinteger

Optional time in seconds to wait before retrying a number

ivr_idinteger

Optional id of the ivr

start_datestring date-time

Optional start date of the campaign

campaign_count_numbersinteger

campaign_count_active_numbersinteger

campaign_count_usersinteger

campaign_count_groupsinteger

is_privateboolean

true if the campaign call is private

is_runningboolean

true if the campaign call is currently running

stop_reasonstring

the reason why the campaign call has been stopped

total_numbers_list_countinteger

total_archive_logsinteger

The size of archive log array

total_start_logsinteger

The size of start log array

Example response

{
  "campaign_calllist_uuid": "b55f949b-c49b-4354-b10a-c8c4cdbd8690",
  "team_id": 123123,
  "user_id": 234234,
  "name": "My campaign CALL List",
  "fifo_left_to_call": 8,
  "update_date": "2018-08-12T12:12:40.53Z",
  "creation_date": "2018-08-12T12:12:40.53Z",
  "deletion_date": "2018-08-12T12:12:40.53Z",
  "max_retry": 3,
  "retry_time": 200,
  "ivr_id": 200,
  "start_date": "2018-08-12T12:12:40.53Z",
  "campaign_count_numbers": 50,
  "campaign_count_active_numbers": 10,
  "campaign_count_users": 5,
  "campaign_count_groups": 7,
  "stop_reason": "no more numbers to call",
  "script": {
    "script_uuid": "1a7a5639-3818-4b0e-9285-f6b3795f8db4",
    "generic_uuid": "1a7a5639-3818-4b0e-9285-f6b3795f8db4",
    "name": "My script",
    "is_enabled": true
  },
  "total_numbers_list_count": 8,
  "total_archive_logs": 1,
  "archive_logs": [
    {
      "team_id": 123123,
      "archived_by_user_id": 123123,
      "unarchived_by_user_id": 123123,
      "archived_start_date": "2018-08-12T12:12:40.53Z",
      "unarchived_start_date": "2018-08-14T11:13:41.53Z"
    }
  ],
  "total_start_logs": 1,
  "start_logs": [
    {
      "team_id": 123123,
      "started_by_user_id": 123123,
      "stopped_by_user_id": 123123,
      "start_date": "2018-08-12T12:12:40.53Z",
      "stop_date": "2018-08-14T11:13:41.53Z"
    }
  ]
}