# List SMS opt-outs

Returns SMS opt-outs, one page at a time.

```http
GET https://api.pozy.ai/v1/sms/opt-outs
```

- Area: Messaging / SMS
- Auth: Authorization: Bearer pz_live_...

## Query parameters

- `format` (string): one of json, csv
- `limit` (integer)

## Example request

```bash
curl -X GET "https://api.pozy.ai/v1/sms/opt-outs?limit=500" \
  -H "Authorization: Bearer $POZY_API_KEY"
```

```ts
const res = await fetch("https://api.pozy.ai/v1/sms/opt-outs?limit=500", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);
```

```python
import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/sms/opt-outs",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "limit": 500,
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())
```

## Response 200

- `optOuts`, array of object
  - `phoneNumber`, string
  - `optedOutAt`, string (date-time): Can be null
  - `keyword`, string: Can be null
  - `from`, string: Can be null
- `count`, integer

```json
{
  "optOuts": [
    {
      "phoneNumber": "+14155550123",
      "optedOutAt": "2026-10-02T09:00:00.000Z",
      "keyword": "string",
      "from": "+14155550123"
    }
  ],
  "count": 42
}
```