# List Opt-Outs

Retrieve a paginated list of opt-out records from your address book.

### <mark style="color:green;">`GET`</mark> `/addressbook/optouts`&#x20;

#### Required Permission

```
read:Optouts
```

Your API key must have this permission enabled in order to use this endpoint.

#### Example Request

```bash
curl --location 'https://<hostname>/addressbook/optouts?offset=0&limit=10' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

Replace `YOUR_API_KEY` with your API key.

{% hint style="info" %}
All endpoints shown in this documentation use a **sample base URL**. The production API endpoint is provided by our team upon request.
{% endhint %}

#### Query Parameters

| Parameter | Type   | Required | Description                             |
| --------- | ------ | -------- | --------------------------------------- |
| offset    | number | No       | Number of records to skip (pagination). |
| limit     | number | No       | Maximum number of records to return.    |

#### Success Response (HTTP 200)

```json
{
  "success": true,
  "records": [
    {
      "msisdn": "55555555555",
      "created_on": "2025-11-10T21:45:12.000Z"
    }
  ],
  "offset": 0,
  "limit": 10,
  "total": 3
}
```

{% hint style="success" %}
This endpoint supports sorting and pagination. See [Search & Pagination Parameters](https://wiki.mobivatebulksms.com/search-and-pagination-parameters/introduction-to-searching-and-pagination) for details.
{% endhint %}