Skip to main content
GET
List campaigns

Authorizations

Authorization
string
header
required

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

Query Parameters

Search campaign frequency, template name, or group name.

Maximum string length: 255
sort
enum<string>
default:start-date

Sort field. Snake-case values are preferred; kebab-case aliases are accepted for portal compatibility.

Available options:
frequency,
start_date,
start-date,
end_date,
end-date,
template_name,
template-name,
group_name,
group-name,
terms,
time
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
per_page
integer
default:25

Number of records per page.

Required range: 1 <= x <= 100

Response

Campaigns returned.

data
object[]
required
pagination
object
required
Last modified on July 20, 2026