v1

latestOpenAPI 3.0.3Proprietary2026-07-13172948.0 KB

Lists outbound campaigns for the specified agent.

get/v1/external/campaigns/{agent_id}

Path parameters

agent_idstring uuid required

The UUID of the AI agent that owns the campaign.

Query parameters

pageinteger
page_sizeinteger
searchstring

Search by campaign name.

statusCampaignStatus[]

Filter by campaign status. Repeat the query parameter for multiple statuses.

sort_bystring
sort_dir'asc' | 'desc'

Response

Campaigns fetched successfully

messagestring required

Example response

{
  "data": {
    "campaigns": [
      {
        "retry_config": {
          "max_retries": 2,
          "retry_delay_minutes": 30,
          "retry_on": [
            "UNANSWERED",
            "REJECTED",
            "VOICEMAIL"
          ]
        }
      }
    ]
  }
}