# List marketing contacts

`GET /api/v1/marketing-contacts`

The store's marketing contacts: one row per resolvable person, with the per-channel consent state that decides whether they may be mailed. THE FILTERS ARE WHAT THIS ROUTE IS FOR. ?email_consent=subscribed is the set you may mail today, which is the question an ESP reconciliation actually asks; ?q= is a substring match over email, phone and both names for a support lookup. Combine them freely. FOUR CONSENT STATES, AND never IS NOT unsubscribed. never means this person was never asked, unsubscribed means they were and said no, and pending is a double opt-in nobody confirmed. Only subscribed is permission to send; collapsing the other three into one is how a platform mails someone who refused. ERASED CONTACTS STAY IN THE LIST rather than disappearing, with erased true and every personal field null. That is deliberate: if the row vanished, every system syncing from this one would keep the copy this platform just destroyed. Treat erased true as a delete on your side. TOTAL SPEND IS NOT PUBLISHED. The stored figure sums minor units across whatever currency each order was placed in and this record carries no currency code, so it is a number you could not interpret. Segment on spend through the segments family instead, where the comparison is evaluated server-side.

## Query parameters

- `q` (string) — Case-insensitive substring match over email, phone_e164, first_name and last_name. % and _ match themselves rather than acting as wildcards, so a search for a literal underscore in a local part finds it and a search for "%" is not an unfiltered export.
- `email_consent` (subscribed | pending | unsubscribed | never) — Filter by the CURRENT email consent state. subscribed is the set you may mail; the other three are not, and they are separate facts rather than shades of the same one. An unrecognised value is a 400, because a client told "no contacts" by a typo concludes the store has an empty list.
- `sms_consent` (subscribed | pending | unsubscribed | never) — The same filter for sms. Consent is per channel, so an email unsubscribe leaves this untouched.
- `push_consent` (subscribed | pending | unsubscribed | never) — The same filter for push.
- `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 <key>` or as `X-API-Key: <key>`. It is
never accepted in a query string.
- `403` — The key lacks the read_marketing_contacts 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/marketing-contacts' \
  --header 'Authorization: Bearer <token>'
```