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
| Operation | Type | Purpose |
|---|---|---|
adminMarketingSubscribers | Query | Cursor-paginated list of all newsletter subscribers |
Details
- Requires an admin Bearer token in the
Authorizationheader. - Cursor pagination — pass
firstfor the page size andafter(theendCursorfrom the previous page) to advance.totalCountis the grand total. customerIdandcustomerNamearenullunless the subscriber's email belongs to a registered customer.- The
channelobject is detail-only — it resolves on the detail query and isnullon list rows.
Filtering
Pass any of these arguments alongside first / after (they mirror the admin datagrid filters):
| Argument | Description |
|---|---|
email | Email — partial match |
channel_id | Channel id — exact match |
is_subscribed | 0 (unsubscribed) / 1 (subscribed) |
sort, order | Sort field (id, email) + asc / desc (default id desc) |

