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.

Operation

OperationTypePurpose
adminMarketingCampaignsQueryCursor-paginated list of all campaigns

Details

  • Requires an admin Bearer token in the Authorization header.
  • Cursor pagination — pass first for the page size and after (the endCursor from the previous page) to advance. totalCount is the grand total.
  • Each node carries the scalar campaign fields shown in the example. The channel, customerGroup, and marketingTemplate objects resolve only on the detail query — they are null on list rows. The campaign's event is REST-only.

Filtering

Pass any of these arguments alongside first / after (they mirror the admin datagrid filters):

ArgumentDescription
nameName — partial match
status0 (inactive) / 1 (active)
marketing_template_idEmail template id — exact match
marketing_event_idEvent id — exact match
channel_idChannel id — exact match
customer_group_idCustomer-group id — exact match
sort, orderSort field (id, name) + asc / desc (default id desc)

Released under the MIT License.