Skip to main content
GET
List All Campaigns
Use filter for a free-text search, sortBy and descending to order the results, and includeDetails=true to include each campaign’s related records (segments, pages, and page statistics). For condition-based searches, use Query Campaigns.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Query Parameters

Filter
string

A free-text search term. Only campaigns whose name, description, or code match the term are returned.

Skip
integer<int32>

The number of records to skip before the first record returned. Use it with take to page through the results.

Take
integer<int32>

The maximum number of records to return in this page of results.

SortBy
enum<string>

Field to sort by (case-insensitive). Valid options: avggiftgoal, enddate, id, startdate

Available options:
avggiftgoal,
enddate,
id,
startdate
Descending
boolean

The direction to sort the results. Set to true to sort in descending order.

IncludeDetails
boolean

When true, each campaign includes its related records: segments, pages, and page statistics. This can slow down large result sets.

Response

OK

A page of campaigns with the total number that match the request.

items
object[]

The campaigns in this page of results.

total
integer<int32>

The total number of campaigns that match the request. Use it with skip and take to page through the full set.

Last modified on July 28, 2026