Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.

Headers

​
Content-Type
string
default:application/json
required

Request body type

Body

application/json
​
page
integer
required

1-based page number.

Required range: x >= 1
Example:

1

​
limit
enum<integer>
required

Records per page. Must be one of 10, 20, 50, 100.

Available options:
10,
20,
50,
100
Example:

10

​
campaign_id
string

Filter by campaign id (partial match).

Example:

"750373463838949401"

​
subject
string

Filter by subject (partial match).

Example:

"welcome"

​
sender
string

Filter by sender email/name (partial match).

Example:

"noreply@yourdomain.com"

​
date_from
string<date>

Inclusive lower bound (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-04-01"

​
date_to
string<date>

Inclusive upper bound (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-04-30"

​
sort_field
enum<string>

Field to sort by.

Available options:
inbox_percentage,
created_date,
campaign_id,
subject,
sent,
opens
Example:

"created_date"

​
sort_order
enum<string>

Sort direction.

Available options:
asc,
desc
Example:

"desc"

Response

Campaign list retrieved successfully

​
status
boolean
Example:

true

​
message
string
Example:

"requested campaign list"

​
data
object[]

List of campaigns matching the filter.

​
pagination
object