# List newsletter subscribers `GET /api/v1/newsletter-subscribers` The store's newsletter list: the address, its consent state, where it joined and when that state last moved. THERE IS NO id FIELD AND THERE WILL NOT BE ONE. The address is the identity: the underlying row is keyed on (store, email) and carries no surrogate, so key your own records on email. It comes back lowercased and trimmed whatever you sent. updated_at is what a suppression sync reconciles on. It is the moment the consent state moved, so a nightly job reads only the rows that changed instead of the whole list. ## Query parameters - `status` (pending | subscribed | unsubscribed) — Filter by consent state. Omit it to receive all three. An unrecognised value is a 400 rather than an empty page: a client filtering on "active" would otherwise conclude the store has no subscribers at all. pending exists only where the store runs double opt-in and those addresses receive no broadcasts, so counting them as reachable overstates the list. - `email` (string) — EXACT match on one address, normalised the same way stored addresses are, so casing and surrounding whitespace do not matter. This is how you ask "is this address on the list, and what is its consent state": there is no per-address route, because a subscriber has no id and putting an address in a path would write it into every proxy and access log verbatim. A malformed address is a 400 rather than an empty page. - `limit` (integer) — Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it. - `after` (string) — The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page. ## Responses - `200` — Success - `400` — The request was refused before any state changed. `code` is one of: `invalid_body`, a write body this route will not take. `reason` partitions it and `field` names the key when one key is at fault. `invalid_query`, a query parameter, including limit and after. `invalid_text`, a NUL byte or bytes that are not valid UTF-8 anywhere in the path, the query or the body. Strip control characters before sending. `idempotency_key_required`, a write sent without the Idempotency-Key header. `invalid_request`, an Idempotency-Key longer than 255 bytes. Routes add their own codes for rules only they know. Switch with a default arm. - `401` — No credential, or one this API does not accept. `code` is always `unauthorized`. THE BODY IS DELIBERATELY UNINFORMATIVE. An expired key, a revoked key, a publishable key, a key belonging to another merchant and a key that never existed are all refused with the same bytes, so this response cannot be used to probe which keys exist. Check the key's state in the dashboard rather than inferring it here. Send the key as `Authorization: Bearer ` or as `X-API-Key: `. It is never accepted in a query string. - `403` — The key lacks the read_newsletter scope. `code` is `insufficient_scope` and the message names the scope to ask the merchant for. - `429` — Too many requests. `code` is `rate_limited`. Two limits apply independently: one on the credential and the route family, one on the client address. The headers describe whichever has less left, so honouring Retry-After always clears the window that bound. - `default` — Any status this operation does not list, in the same envelope. A 5xx means the request may or may not have applied. Retry it with the SAME Idempotency-Key: that is the only way to find out without risking a duplicate, and it is what the key is for. A few 4xx conditions arrive here rather than as a listed status because they depend on the merchant's plan or on a module being wired: 402 when a quota or a plan limit is reached, and 503 when a capability the route needs is not configured on this deployment. Both carry a `code` naming which. ## Example ```bash curl --request GET \ --url 'https://api.mercemur.com/api/v1/newsletter-subscribers' \ --header 'Authorization: Bearer ' ```