---
title: "List opt-outs in the workspace"
method: GET
path: "/v1/optouts"
tags: ["Opt-outs"]
---

# List opt-outs in the workspace

`GET /v1/optouts`

Return a workspace-wide list of opt-outs across all channels. Each entry represents a person and the senders/channels (SMS or WhatsApp) they've opted out of.

A person opts out of a specific sender on a specific channel—for example, a person can opt out of SMS messages from one sender number while continuing to receive messages from another. An entry's presence in the `optouts` array means the person is opted out of that sender/channel.

Use the `from` parameter to filter for a specific sender. Use the `start` parameter with the `next` value from the previous response to paginate through results.

**Note**: SMS sender values are stored normalized (trimmed and lowercased). For alphanumeric SMS senders and messaging-service SIDs, the response recovers the original casing from your workspace's Twilio sender identities. E.164 phone numbers are unaffected.

## Response `200`

Returns an array of opt-out records, one per person.

- object
  - `optouts` object[] — A list of people and their opt-outs. Each object represents a person and the senders/channels they've opted out of.
    - `customer_id` string — The person's ID.
    - `cio_id` string — A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.
    - `optouts` object[] — The senders and channels that the person is opted out of. An entry's presence means the person is opted out of that sender on that channel.
      - `channel` 'sms' | 'whatsapp' — The channel that the person is opted out of.
      - `from` string — The sender that the person is opted out of. For SMS, this is a sender phone number (E.164), an alphanumeric sender ID, or a messaging-service SID; for WhatsApp, it's the sender phone number.
  - `next` string — The `start` value for the next page of results. Absent or empty when there are no more results.

## Other responses

- `401` — Unauthorized request. Make sure that you provided the right credentials.
- `429` — Your request is over the 10-per-second limit.

---

[API](https://skmtc.dev/customer/apis/customer-io-journeys-api-reference.md) · [All operations](https://skmtc.dev/customer/apis/customer-io-journeys-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/customer/customer-io-journeys-api-reference/revisions/4b391af7cb06/schema)