---
title: "List people who must not be messaged"
method: GET
path: "/v1/opt-outs"
tags: ["Opt-outs"]
---

# List people who must not be messaged

`GET /v1/opt-outs`

## Request

- Base URL: `https://www.chatrail.dev`
- URL: `https://www.chatrail.dev/v1/opt-outs`
- Auth: HTTP bearer

Numbers on the workspace's opt-out list, oldest first. A number gets here two ways: the person wrote a stop word such as "STOP" in a direct chat (`source: inbound_keyword`), or you added it (`source: api`). Sends to a number on the list are refused with `RECIPIENT_OPTED_OUT`, and so are messages already queued or scheduled for it.

## Query parameters

- `limit` integer
- `cursor` string, uuid

## Response `200`

A page of opt-outs, with `next_cursor` when there is more.

---

[API](https://skmtc.dev/chatrail/apis/chatrail-api.md) · [All operations](https://skmtc.dev/chatrail/apis/chatrail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chatrail/apis/chatrail-api/revisions/acc5b88c6f59?raw)