Skip to main content
GET
List campaign

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer

The number of items to return

Required range: 1 <= x <= 100
Example:

10

starting_after
string

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example:

"01956fbd-0eb1-72db-a565-82977a586084"

Search by campaign name

Example:

"Summer Sale Campaign"

tag_ids
string

Filter campaigns by tag ids. Returns campaigns that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma.

Example:

"019f985c-92b0-777b-959b-90c734332805,019f985c-92b0-777b-959b-90c88ef7f58c"

ai_sales_agent_id
string<uuid>

Filter campaigns by AI Sales Agent ID. Returns campaigns that were created by the specified AI Sales Agent.

Example:

"019f985c-92b0-777b-959b-90c9f0f0d2ce"

status
enum<number>

Filter campaigns by status using the campaign status enum value (e.g., ACTIVE, PAUSED).

Available options:
-99,
-1,
-2,
0,
1,
2,
3,
4
Example:

1

exclude_status
enum<number>

Exclude campaigns with this status using the campaign status enum value (e.g., exclude ACTIVE to list only campaigns that are not currently active).

Available options:
-99,
-1,
-2,
0,
1,
2,
3,
4
Example:

1

Response

The list of Campaign

items
Campaign · object[]
required

The list of Campaign

next_starting_after
string

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example:

"019f985c-92b0-777b-959b-90ca3d64319f"