Skip to content

List Newsletter Subscribers

Lists every newsletter subscriber in the store — the data behind the admin Marketing → Communications → Newsletter Subscribers datagrid.

TIP

New here? Read the Newsletter Subscribers overview for what a subscriber is and how its fields behave.

Operation

OperationTypePurpose
adminMarketingSubscribersQueryCursor-paginated list of all newsletter subscribers

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.
  • customerId and customerName are null unless the subscriber's email belongs to a registered customer.
  • The channel object is detail-only — it resolves on the detail query and is null on list rows.

Filtering

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

ArgumentDescription
emailEmail — partial match
channel_idChannel id — exact match
is_subscribed0 (unsubscribed) / 1 (subscribed)
sort, orderSort field (id, email) + asc / desc (default id desc)

Released under the MIT License.