Ctrl K

Outbound Campaigns

List campaigns

List all campaigns (call, WhatsApp, SMS)

Updated 27 July 2026

Returns every campaign you own, including channel, schedule windows, WhatsApp/SMS config, and optional call→text fallback settings.

Response

Returns a JSON array of campaign objects.

idinteger

Campaign ID

namestring

Campaign name

channelstring

call, whatsapp, or sms

statusstring

e.g. draft, scheduled, in-progress, paused, completed

assistant_idinteger

OUTBOUND assistant ID (call campaigns). null for text campaigns.

timezonestring

IANA timezone for the send/call window

max_calls_in_parallelinteger

Concurrent call slots (call campaigns)

messages_per_minuteinteger

Per-campaign text send rate (WhatsApp/SMS). WhatsApp also uses a user-wide in-flight pool of 10.

schedule_windowsarray

Daily windows [{ "start": "HH:MM", "end": "HH:MM" }]. Overnight allowed when end < start.

scheduled_start_atstring

ISO datetime for auto-start, or null

allowed_hours_start_timestring

Legacy window start (kept in sync with the first schedule window)

allowed_hours_end_timestring

Legacy window end

allowed_daysarray

Weekdays when sending/calling is allowed

max_retriesinteger

Max retries per lead

retry_intervalinteger

Minutes between retries

retry_on_voicemailboolean

Call campaigns: retry on voicemail

retry_on_goal_incompleteboolean

Call campaigns: retry until goal variable is true

goal_completion_variablestring

Boolean post-call variable name, or null

mark_complete_when_no_leadsboolean

Auto-complete when no work remains

phone_number_idsarray

Outbound from-number IDs (call campaigns)

whatsapp_sender_idinteger

WhatsApp sender ID, or null

whatsapp_template_idinteger

WhatsApp template ID, or null

sms_from_phone_number_idinteger

SMS from-number ID, or null

sms_bodystring

SMS body, or null

text_variable_mappingobject

WhatsApp template placeholder → lead variable map, or null

fallback_channelstring

Call→text fallback channel (whatsapp / sms), or null

fallback_whatsapp_sender_idinteger

Fallback WhatsApp sender, or null

fallback_whatsapp_template_idinteger

Fallback WhatsApp template, or null

fallback_sms_from_phone_number_idinteger

Fallback SMS from-number, or null

fallback_sms_bodystring

Fallback SMS body, or null

fallback_variable_mappingobject

Fallback WhatsApp variable map, or null

created_atstring

Created timestamp in your account timezone

updated_atstring

Updated timestamp in your account timezone

[
  {
    "id": 1,
    "name": "Product Demo Campaign",
    "channel": "call",
    "status": "in-progress",
    "assistant_id": 42,
    "timezone": "Europe/Bucharest",
    "max_calls_in_parallel": 3,
    "messages_per_minute": null,
    "schedule_windows": [{ "start": "09:00", "end": "18:00" }],
    "scheduled_start_at": null,
    "allowed_hours_start_time": "09:00:00",
    "allowed_hours_end_time": "18:00:00",
    "allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "max_retries": 3,
    "retry_interval": 60,
    "retry_on_voicemail": false,
    "retry_on_goal_incomplete": false,
    "goal_completion_variable": null,
    "mark_complete_when_no_leads": true,
    "phone_number_ids": [11],
    "whatsapp_sender_id": null,
    "whatsapp_template_id": null,
    "sms_from_phone_number_id": null,
    "sms_body": null,
    "text_variable_mapping": null,
    "fallback_channel": "whatsapp",
    "fallback_whatsapp_sender_id": 7,
    "fallback_whatsapp_template_id": 15,
    "fallback_sms_from_phone_number_id": null,
    "fallback_sms_body": null,
    "fallback_variable_mapping": { "1": "customer_name" },
    "created_at": "2026-07-24 10:00:00",
    "updated_at": "2026-07-24 12:00:00"
  },
  {
    "id": 2,
    "name": "WhatsApp Follow-up",
    "channel": "whatsapp",
    "status": "draft",
    "assistant_id": null,
    "messages_per_minute": 10,
    "schedule_windows": [{ "start": "09:00", "end": "20:00" }],
    "whatsapp_sender_id": 7,
    "whatsapp_template_id": 15,
    "text_variable_mapping": { "1": "customer_name" },
    "fallback_channel": null
  }
]