Sign in

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

Changes

Changed in 4 of the 17 revisions of this API.144

  • 15c9445bbca81See the full diff
    • ●

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

      request-parameter-max-set

  • b9d6c9669dfa33See the full diff
    • ●

      removed the optional property data/campaigns/items/cps from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/campaigns/items/metadata from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/campaigns/items/schedule_config from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property data/campaigns/items/retry_config/max_retries to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/campaigns/items/retry_config/retry_delay_minutes to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/campaigns/items/retry_config/retry_on to the response with the 200 status

      response-optional-property-added

  • c05ce18c84191See the full diff
    • ○

      endpoint added

      endpoint-added

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 33 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog