v1
latestOpenAPI 3.0.32026-07-246376162.1 KBCampaigns
Get list of campaigns
Returns a paginated list of all dialer campaigns.
get/api/v4/campaigns
Query parameters
limitinteger
The number of items to return.
offsetinteger
The number of items to skip before starting to collect the result set.
namestring
Example:Summer Outreach Campaign
A campaign name.
Filter by strategy. Accepts a single value or an array.
Filter by status. Accepts a single value or an array.
Filter by method. Accepts a single value or an array.
liveboolean
Example:true
Whether or not the campaign type is live.
Response
OK
Example response
{
"campaigns": [
{
"id": 3,
"name": "Summer Outreach Campaign",
"status": "active",
"strategy": "simple",
"dial_level": 1,
"dial_level_override": {
"enabled": true,
"value": 1.5,
"active_agents_threshold": 3
},
"max_dial_time": 60,
"max_wait_time": 5,
"max_dial_attempts": 3,
"voice_message": {
"type": "voice_message",
"name": "Instructions"
},
"amd_voicemail_message": {
"voice_message": {
"type": "voice_message",
"name": "Instructions"
}
},
"amd_enabled": true,
"live": {
"enabled": true,
"dialing_order": "fifo"
},
"calling_list": {
"method": "file_import"
},
"caller_id_sets": [
{
"phone_numbers": [
"18885650001",
"18885650002"
]
}
],
"asr_optimization_enabled": true,
"follow_up_mode": "timer",
"follow_up_rules": {
"machine_answered": [
{
"type": "redial",
"wait_time": 20,
"wait_time_unit": "minutes",
"actions": [
{
"type": "whatsapp",
"channel_profile": {
"id": 12,
"channel": "whatsapp",
"identifier": "18885658889",
"name": "WhatsApp Main (18885658889)"
},
"whatsapp_template": {
"id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
"name": "Missed Call Follow-up"
}
}
]
}
],
"abandoned": [
{
"type": "redial",
"wait_time": 20,
"wait_time_unit": "minutes",
"actions": [
{
"type": "whatsapp",
"channel_profile": {
"id": 12,
"channel": "whatsapp",
"identifier": "18885658889",
"name": "WhatsApp Main (18885658889)"
},
"whatsapp_template": {
"id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
"name": "Missed Call Follow-up"
}
}
]
}
],
"no_answer": [
{
"type": "redial",
"wait_time": 20,
"wait_time_unit": "minutes",
"actions": [
{
"type": "whatsapp",
"channel_profile": {
"id": 12,
"channel": "whatsapp",
"identifier": "18885658889",
"name": "WhatsApp Main (18885658889)"
},
"whatsapp_template": {
"id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
"name": "Missed Call Follow-up"
}
}
]
}
],
"rejected": [
{
"type": "redial",
"wait_time": 20,
"wait_time_unit": "minutes",
"actions": [
{
"type": "whatsapp",
"channel_profile": {
"id": 12,
"channel": "whatsapp",
"identifier": "18885658889",
"name": "WhatsApp Main (18885658889)"
},
"whatsapp_template": {
"id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
"name": "Missed Call Follow-up"
}
}
]
}
],
"failed": [
{
"type": "redial",
"wait_time": 20,
"wait_time_unit": "minutes",
"actions": [
{
"type": "whatsapp",
"channel_profile": {
"id": 12,
"channel": "whatsapp",
"identifier": "18885658889",
"name": "WhatsApp Main (18885658889)"
},
"whatsapp_template": {
"id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
"name": "Missed Call Follow-up"
}
}
]
}
],
"busy": [
{
"type": "redial",
"wait_time": 20,
"wait_time_unit": "minutes",
"actions": [
{
"type": "whatsapp",
"channel_profile": {
"id": 12,
"channel": "whatsapp",
"identifier": "18885658889",
"name": "WhatsApp Main (18885658889)"
},
"whatsapp_template": {
"id": "3f0a7ce4-1b82-4c38-9e59-1e57dc8e2b52",
"name": "Missed Call Follow-up"
}
}
]
}
]
},
"post_call_rating": {
"enabled": true,
"notification_voice_message": {
"type": "voice_message",
"name": "Instructions"
},
"instructions_voice_message": {
"type": "voice_message",
"name": "Instructions"
},
"complete_voice_message": {
"type": "voice_message",
"name": "Instructions"
}
},
"contact_local_time": {
"start_time": "07:30",
"end_time": "22:00",
"days_of_week": [
1,
2,
3,
4,
5
]
},
"created_at": "2026-01-15T10:30:00.123000Z",
"updated_at": "2026-01-20T14:15:00.456000Z"
}
],
"metadata": {
"total": 100
}
}