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.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/marketing/subscribers | GET |
Response envelope
Admin collections return a { data, meta } body envelope:
data— the subscriber rows for this page.meta—currentPage,perPage,lastPage,total,from,to.
Each row carries the subscriber field set shown in the example. customerId and customerName are null unless the subscriber's email matches a registered customer. The channel object is detail-only — it appears on the detail and toggle responses and is null on list rows.
Query parameters
| Parameter | Description |
|---|---|
page, per_page | Pagination (per_page default 10, max 50) |
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) |
Filters compose with logical AND — more filters narrow the result.
Every /api/admin/* request requires an admin Bearer token.