I-i-stem

GET /v1/external/campaigns/{agent_id}

Changed on

Lists outbound campaigns for the specified agent.

Request

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"
          ]
        }
      }
    ]
  }
}

Changes

  • 15c9445bbca8Revision changes
    • warning

      for the query request parameter page_size, the max was set to 100.00

  • b9d6c9669dfaRevision changes
    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status