Agents Platform

List Outbound Campaigns

Changed on

List the workspace's outbound campaigns, newest first.

get/v1/convai/outbound-campaigns/campaigns

Request

Query parameters

page_sizeinteger

How many items to return at most.

statusCampaignStatus[] nullable

Only campaigns in one of these statuses.

agent_idstring nullable

Only campaigns run by this agent.

channel'phone' | 'whatsapp'

Only campaigns on this channel.

mode'voice' | 'message' nullable

Only voice or only message campaigns.

searchstring nullable

Only campaigns whose name contains this text.

cursorstring nullable

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

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

next_cursorstring nullable required
has_moreboolean required

Changes