List campaigns

GET

/v1/convai/outbound-campaigns/campaigns

GET

/v1/convai/outbound-campaigns/campaigns

curl https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns

{
  "campaigns": [
    {
      "campaign_id": "string",
      "call_name": "string",
      "agent_id": "string",
      "channel_config": {
        "channel": "phone",
        "agent_phone_number_id": "string",
        "mode_config": {
          "ringing_timeout_secs": 60,
          "twilio_call_recording_enabled": false,
          "twilio_machine_detection": {
            "mode": "enable",
            "actions": [
              {
                "action": "hang_up",
                "answered_by": [
                  "human"
                ]
              }
            ]
          },
          "mode": "voice"
        }
      },
      "status": "active",
      "policy": {
        "timezone": "string",
        "retry": {
          "retry_delay_seconds": 600,
          "max_short_retries": 1,
          "max_total_calls": 6,
          "max_callbacks": 2,
          "max_redirects": 2,
          "interval_placement": "start",
          "rotate_step_seconds": 900,
          "max_consecutive_failures_per_number": 1
        },
        "calling_periods": [
          {
            "weekdays": [
              1
            ],
            "intervals": [
              {
                "start": "string",
                "end": "string"
              }
            ]
          }
        ],
        "data_collection": {
          "callback_time": "string",
          "redirect_phone_number": "string",
          "stop": "string",
          "mappings": {}
        },
        "followup_context": {
          "call_type": true,
          "previous_conversation_id": true,
          "previous_summary": true,
          "previous_transcript": true
        }
      },
      "variant": "simple",
      "source": "ui",
      "outcome": {
        "type": "evaluation_criteria",
        "criteria_id": "string"
      },
      "created_at_unix": 1,
      "scheduled_time_unix": 1,
      "updated_at_unix": 1,
      "branch_id": "string",
      "environment": "string",
      "target_concurrency_limit": 1,
      "channel": "phone",
      "mode": "voice",
      "counts": {
        "leads": 1,
        "terminal_leads": 1,
        "open_attention": 1,
        "delivery": {
          "sent": 0,
          "delivered": 0,
          "read": 0,
          "replied": 0,
          "failed": 0
        }
      },
      "agent_name": ""
    }
  ],
  "next_cursor": "string",
  "has_more": true
}

List the workspace's outbound campaigns, newest first.

Query parameters

page_sizeintegerOptional1-500Defaults to 100

How many items to return at most.

statuslist of enums or nullOptional

Only campaigns in one of these statuses.

agent_idstring or nullOptional

Only campaigns run by this agent.

channelenum or nullOptional

Only campaigns on this channel.

Allowed values:

modeenum or nullOptional

Only voice or only message campaigns.

Allowed values:

searchstring or nullOptional<=256 characters

Only campaigns whose name contains this text.

cursorstring or nullOptional

Used for fetching next page. Cursor is returned in the response.

Response

Successful Response

campaignslist of objects

next_cursorstring or null

has_moreboolean

Errors

422

Unprocessable Entity Error

Headers

Query parameters

Response

Errors