# Read the do-not-contact list

The addresses this workspace may not text, email or call, newest first: each phone number (E.164) or email address (lower-case), how it got there (inbound_reply when the contact replied STOP or similar, manual when a member listed it or moved the record to do not contact), the reason, the record it was listed against and who listed it. q matches the address, a number in any spelling, or the record name; limit and offset page it and total is the matched count. Read it before reaching out to somebody who may have asked to stop: every send to a listed address is refused.

Access class: `workspace`.

## Endpoint

`GET /v1/comms/opt-outs`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| limit | query | integer | No |
| offset | query | integer | No |
| q | query | string | No |

## Responses

### 200

the action's answer

Content type: `application/json`.

```json
{
  "data": [
    {
      "address": "string",
      "kind": "string",
      "optedOutAt": "string",
      "optedOutBy": {
        "accountId": "",
        "name": "string"
      },
      "reason": "string",
      "source": "string"
    }
  ],
  "total": 1.5
}
```

### default

a refusal: `{"error": "<what a person needs to read>"}`. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

Content type: `application/json`.

```json
{
  "error": "string"
}
```
