Skip to main content
GET
Fetch campaign mailings

Authorizations

authorization
string
header
required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Query Parameters

Regex string to search on. Compares against subject

template_type
string

Return only mailings authored in this editor, for example quill, bee or html

order_by
string

Attribute to sort on. Must be a campaign mailing column name, for example subject or created_at. When omitted, no explicit ordering is applied.

order
enum<string>
default:asc

Direction to sort. Only applied when order_by is supplied.

Available options:
asc,
desc
items
integer
default:20

Number of records to return per page

Required range: 1 <= x <= 100
page
integer
default:1

For pagination of results

Required range: x >= 1
pagination
boolean
default:true

Set to false to disable pagination and return every matching campaign mailing in one response.

Response

Campaign mailings data

data
object[]