Retrieve Campaigns

get

https://{APP_DOMAIN}/api/3.2/marketing/campaigns

Returns a paginated list of campaigns that track how subscribers are acquired and group marketing efforts together. Includes related partner, lift letter, advertorial, promo, order page, publication, and tags.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

integer

Filter by campaign ID

active

boolean

Filter by active status

name

string

Filter by name

publication_id

array of integers

Filter by publication ID. Accepts a single value or an array.

publication_id

partner_id

array of integers

Filter by partner ID. Accepts a single value or an array.

partner_id

lift_id

array of integers

Filter by lift letter ID. Accepts a single value or an array.

lift_id

advertorial_id

array of integers

Filter by advertorial landing page ID. Accepts a single value or an array.

advertorial_id

promo_id

array of integers

Filter by promo landing page ID. Accepts a single value or an array.

promo_id

order_page_id

array of integers

Filter by order page landing page ID. Accepts a single value or an array.

order_page_id

effort_id

integer

Filter by effort ID

tag_id

array of integers

Filter by tag ID. Accepts a single value or an array.

tag_id

is_external

boolean

Filter by external campaigns (true = has external_url, false = no external_url)

id_with_name

string

Search by ID or name (partial match on both)

created_at

string

Filter by creation date. Supports operators: >, >=, <, <=

updated_at

string

Filter by last updated date. Supports operators: >, >=, <, <=

page

integer

The page to return.

per_page

integer

The total results to return per page.

sort

string

The field to sort the request by. column_name|asc OR desc

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200The retrieved campaigns