Skip to content

List Campaigns

Lists every campaign in the store — the data behind the admin Marketing → Communications → Campaigns datagrid.

TIP

New here? Read the Campaigns overview for what a campaign does and how its fields behave.

Endpoint

EndpointMethod
/api/admin/marketing/campaignsGET

Response envelope

Admin collections return a { data, meta } body envelope:

  • data — the campaign rows for this page.
  • metacurrentPage, perPage, lastPage, total, from, to.

Each row carries the campaign's scalar fields shown in the example. The channel, customerGroup, marketingTemplate, and marketingEvent objects are served only by the detail endpoint; they are null on list rows.

Query parameters

ParameterDescription
page, per_pagePagination (per_page default 10, max 50)
nameName — partial match
status0 (inactive) / 1 (active)
marketing_template_idLinked email-template id
marketing_event_idLinked event id
channel_idChannel id
customer_group_idCustomer-group id
sort, orderSort field (id, name) + asc / desc (default id desc)

Filters compose with logical AND — more filters narrow the result.

Every /api/admin/* request requires an admin Bearer token.

Released under the MIT License.