---
title: "List SMS opt-outs"
method: GET
path: "/v1/sms/opt-outs"
tags: ["SMS"]
---

# List SMS opt-outs

`GET /v1/sms/opt-outs`

The recipients who opted out of SMS (replied STOP) across your numbers,
most recent first. Compliance surface: you must be able to see and
export your opt-out list. Read-only: a recipient is re-subscribed only
by replying START. Pass `format=csv` to download a CSV instead of JSON.

## Query parameters

- `format` 'json' | 'csv'
- `limit` integer

## Response `200`

Opt-out list

- object
  - `optOuts` object[]
    - `phoneNumber` string
    - `optedOutAt` string, date-time, nullable
    - `keyword` string, nullable — The keyword they sent (e.g. STOP), when the carrier recorded one.
    - `from` string, nullable — Which of your numbers the recipient opted out from.
  - `count` integer

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/zernio/apis/zernio-api.md) · [All operations](https://skmtc.net/zernio/apis/zernio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zernio/zernio-api/revisions/f81ca70ea6b9/schema)