> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://esendex.ferndocs.com/api-reference/opt-outs/get-all-opt-outs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://esendex.ferndocs.com/_mcp/server.

# Get all opt-outs

GET http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts

Reference: https://esendex.ferndocs.com/api-reference/opt-outs/get-all-opt-outs

## Authentication

- `X-API-Key` header (required) — Your Esendex API key.

## Request

### Query parameters

- `Address` (string, optional)
- `Channel` (string, optional)
- `SortBy` (enum, optional)
  - Allowed values: `Address`, `Channel`, `CreatedAt`, `AccountReference`
- `OptOutMethod` (enum, optional)
  - Allowed values: `Stop`, `Manual`, `Weblink`
- `StartTime` (datetime, optional)
- `EndTime` (datetime, optional)
- `SortOrder` (enum, optional)
  - Allowed values: `Asc`, `Desc`
- `PageNo` (V2OptoutsGetParametersPageNo, optional)
- `PageSize` (V2OptoutsGetParametersPageSize, optional)

### Headers

- `AccountReference` (string, optional) — Optional AccountReference header

## Response

### 200

OK

- `data` (GetAllOptOutsResponse, optional, nullable)
- `errors` (list of ErrorDto, optional, nullable)

## Types

### V2OptoutsGetParametersPageNo

### V2OptoutsGetParametersPageSize

### GetAllOptOutsResponse

- `optOuts` (list of GetAllOptOutsResponseOptOutsItems, optional)
- `totalCount` (GetAllOptOutsResponseTotalCount, optional)
- `totalPages` (GetAllOptOutsResponseTotalPages, optional)
- `currentPage` (GetAllOptOutsResponseCurrentPage, optional)

### ErrorDto

- `errorCode` (string, required)
- `errorMessage` (string, required)
- `metadata` (map from string to string, optional, nullable)

### GetAllOptOutsResponseOptOutsItems

- `id` (string, optional)
- `accountReference` (string, optional, nullable)
- `channel` (string, optional, nullable)
- `value` (string, optional, nullable)
- `createTimestamp` (datetime, optional)
- `optOutMethod` (enum, optional)
  - Allowed values: `Stop`, `Manual`, `Weblink`

### GetAllOptOutsResponseTotalCount

### GetAllOptOutsResponseTotalPages

### GetAllOptOutsResponseCurrentPage

## Examples

**Response**

```json
{
  "data": null,
  "errors": null
}
```

**SDK Code**

```python
import requests

url = "http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts"

headers = {"X-API-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts';
const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "http://gateway-api.e97e9e55a5d242f9a139.uksouth.aksapp.io/v2/optouts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```