# List cart recovery optouts

`GET /api/v1/cart-recovery-optouts`

The store's SUPPRESSION list: every address that asked this merchant to stop mailing them. It is published so you can honour the same suppressions in your own sending. It is not a mailing list, and treating it as a source of contactable people inverts its entire meaning. THERE IS NO GET BY ADDRESS because ?email= answers the same question better. "Is this address suppressed" returns an empty page when it is not, which is the correct answer; a 404 would be an error status for a perfectly normal outcome and every client would have to treat it as success. Addresses are stored lowercased and trimmed. Normalise the same way before comparing, or a mixed-case address reads as absent and mail goes to someone who asked a merchant to stop.

## Query parameters

- `email` (string) — Exact match, not a prefix search, so this list cannot be enumerated by guessing. It is how you ask whether one address is suppressed before a send: an address that is not returns an EMPTY PAGE rather than a 404, because "nobody suppressed" is a normal answer and not an error. The value is lowercased and trimmed before it is matched, so case does not matter here. A malformed address is also an empty page rather than a 400: on a filter that is a question with a correct answer.
- `reason` (unsubscribe | bounce | complaint | manual) — Filter by why the address was suppressed. An unrecognised value is a 400 rather than an empty page: "no address was suppressed for that reason" and "there is no such reason" are different facts, and a client told the former concludes the complaints it forwarded never arrived.
- `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_cart_recovery 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/cart-recovery-optouts' \
  --header 'Authorization: Bearer <token>'
```