---
title: "List opt-out records"
method: GET
path: "/v1/compliance/opt-outs"
tags: ["Compliance / CASL"]
---

# List opt-out records

`GET /v1/compliance/opt-outs`

## Request

- Base URL: `https://api.honkio.ca`
- URL: `https://api.honkio.ca/v1/compliance/opt-outs`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Requires `compliance:r`.

## Query parameters

- `phone_number` string
- `from_number` string
- `page` integer
- `limit` integer

## Response `200`

A page of opt-out records, newest first. No total is returned.

- object: A page of opt-out records, newest first. No total is returned.
  - `data` OptOut[], required
    - `id` string, required
    - `accountId` string, required
    - `channel` 'SMS' | 'EMAIL', required
    - `phoneNumber` string, nullable, required
    - `fromNumber` string, nullable, required: The sending number the subscriber opted out from (SMS).
    - `fromAddress` string, nullable, required
    - `emailAddress` string, nullable, required
    - `keywordUsed` string, nullable, required: STOP, UNSUBSCRIBE and so on; null for an opt-out recorded through the API.
    - `optedOutAt` string, date-time, required
    - `reinstatedAt` string, date-time, nullable, required
    - `reinstateKeyword` string, nullable, required

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: The API key lacks the permission this operation requires, or the account is suspended or closed.
- `422`: VALIDATION_ERROR: the request failed validation; details names the fields.
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.

---

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