Skip to main content
GET
List campaigns
Each campaign comes with progress counts. See Progress fields and Status values. The list doesn’t include the schedule and retry settings. Use Get a campaign for those. Use meta.totalPages to know when you’ve fetched every page.

Authorizations

X-API-KEY
string
header
required

Query Parameters

page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
limit
integer
default:10

Campaigns per page.

Required range: x >= 1

Matches campaigns whose name contains the text. Not case-sensitive.

isActive
boolean

Only running campaigns (true) or only paused ones (false).

agentId
string<uuid>

Only campaigns that use this agent.

customerListId
string<uuid>

Only campaigns that call this customer list.

Response

A page of campaigns.

message
string
Example:

"Campaigns fetched successfully"

meta
object
data
object[]