Skip to content

List Events

Lists every marketing event in the store — the data behind the admin Marketing → Communications → Events datagrid.

TIP

New here? Read the Events overview for what an event does and how its fields behave.

Endpoint

EndpointMethod
/api/admin/marketing/eventsGET

Response envelope

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

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

Each row carries the full event field set shown in the example.

Query parameters

ParameterDescription
page, per_pagePagination (per_page default 10, max 50)
nameName — partial match
date_from, date_toEvent-date range (YYYY-MM-DD)
sort, orderSort field (id, name, date) + 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.