Logo
Platform Guide
API Reference
Platform Updates
Platform updates
Campaigns

List campaigns

List all campaigns

GET

/ user / campaigns

This endpoint allows you to list all campaigns.

Response fields

campaigns array

id integer

The id of the campaign

name string

The name of the campaign

status string

The status of the campaign

max_calls_in_parallel integer

Maximum number of calls that can be made in parallel

mark_complete_when_no_leads boolean

Whether to mark the campaign as complete when there are no leads

allowed_hours_start_time string

The start time for allowed calling hours

allowed_hours_end_time string

The end time for allowed calling hours

allowed_days array

The days of the week when calls are allowed

max_retries integer

Maximum number of retry attempts for failed calls

retry_interval integer

Interval in seconds between retry attempts

created_at string

The timestamp when the campaign was created

updated_at string

The timestamp when the campaign was last updated

List campaigns
200 Response
[
  {
    "id": 1,
    "name": "Test campaing",
    "status": "draft",
    "max_calls_in_parallel": 3,
    "mark_complete_when_no_leads": true,
    "allowed_hours_start_time": "00:00:00",
    "allowed_hours_end_time": "23:59:00",
    "allowed_days": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday",
      "saturday",
      "sunday"
    ],
    "max_retries": 3,
    "retry_interval": 60,
    "created_at": "2025-05-29T07:18:34.000000Z",
    "updated_at": "2025-05-29T07:18:34.000000Z"
  }
]