Skip to main content
GET

Authorizations

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

Query Parameters

string
Filter campaigns by status. One of: draft, scheduled, sending, sending_gradual, paused, sent, failed, aborted.
string
Filter campaigns by name. Supports partial matching.
integer
Page number for pagination. Must be at least 1. Defaults to 1.
integer
Number of results to return per page. Must be between 1 and 100. Defaults to 20.
string
ISO 8601 date-time string. Only campaigns created on or after this date are returned.
string
ISO 8601 date-time string. Only campaigns created on or before this date are returned.
string
Whether to include recipient and send counts in each campaign object. Pass "true" or "false".

Response

Returns a paginated list of campaign objects.
boolean
Indicates whether the request was successful.
object
Response payload.