Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Your unique organization API key. Required on all requests.

Path Parameters

agent_id
string<uuid>
required

The UUID of the AI agent that owns the campaign.

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:10
Required range: 1 <= x <= 100

Search by campaign name.

status
enum<string>[]

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

Available options:
DRAFT,
SCHEDULED,
IN_PROGRESS,
PAUSED,
FINISHED,
FAILED,
CANCELLED
sort_by
string
default:created_at
sort_dir
enum<string>
default:desc
Available options:
asc,
desc

Response

Campaigns fetched successfully

message
string
required
data
object
required