> For the complete documentation index, see [llms.txt](https://docs.tnid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tnid.com/api-reference/002_company/008_opt_out/001__list_opt_out_requests.md).

# List Opt-out Requests

GraphQL endpoint: `/company`

List all opt-out requests received by the authenticated company. Opt-out requests are created when users request to stop receiving communications.

Optional filters:

* `type`: Filter by type (SMS, VOICE, EMAIL)
* `status`: Filter by status (PENDING, ACCEPTED, REJECTED)
* `source`: Filter by source/sender
* `destination`: Filter by destination/recipient
* `externalId`: Filter by external identifier
* `timestampBefore`: Filter by timestamp
* `timestampAfter`: Filter by timestamp
* `limit`: Maximum number of results

Returns opt-out requests with associated user information (if available).

## Query

```graphql
query (
  $type: OptOutRequestType
  $status: OptOutRequestStatus
  $source: String
  $destination: String
  $externalId: String
  $timestampBefore: NaiveDateTime
  $timestampAfter: NaiveDateTime
  $limit: Int
) {
  optOutRequests (
    type: $type
    status: $status
    source: $source
    destination: $destination
    externalId: $externalId
    timestampBefore: $timestampBefore
    timestampAfter: $timestampAfter
    limit: $limit
  ) {
    id
    source
    destination
    externalId
    messageBody
    type
    status
    createdAt
    updatedAt
    timestamp
    metadata
    company {
      id
      legalName
      brandName
      profileName
      yearFounded
      aboutUs
      metadata
      verified
      logoUrl
      verticalType {
        id
        displayName
        description
      }
      organizationType {
        id
        displayName
      }
      addresses {
        city
        country
        state
        street
        types
        zipCode
      }
      emails {
        email
      }
      telephoneNumbers {
        number
      }
      socialNetworks {
        type
        url
      }
      webpages {
        type
        url
      }
      specialties {
        description
        title
      }
      subscriptionTopics {
        id
        name
      }
    }
    user {
      id
      username
      firstName
      middleName
      lastName
      birthdate
      aboutMe
      timezone
      metadata
      addresses {
        city
        country
        state
        street
        types
        zipCode
      }
      emails {
        email
      }
      telephoneNumbers {
        number
      }
      socialNetworks {
        type
        url
      }
      webpages {
        type
        url
      }
      interests {
        description
        title
      }
    }
  }
}

```

## Variables

```json
{}
```

## Response

```json
{
  "data": {
    "optOutRequests": [
      {
        "company": {
          "aboutUs": "about us content",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 1",
              "types": [
                "HEADQUARTERS"
              ],
              "zipCode": "12345"
            }
          ],
          "brandName": "1brand-name",
          "emails": [
            {
              "email": "test2@email.com"
            }
          ],
          "id": "00000000-0000-4000-8000-000000000001",
          "legalName": "2legal-name",
          "logoUrl": "http://localhost:4566/logo_url?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=SOME_RANDOM_ACCESS_KEY%2F20260115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000",
          "metadata": {
            "test": "value"
          },
          "organizationType": {
            "displayName": "display_name_3",
            "id": "00000000-0000-4000-8000-000000000002"
          },
          "profileName": "3profile-name",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm4.not"
            }
          ],
          "specialties": [
            {
              "description": null,
              "title": "Telecommunications"
            }
          ],
          "subscriptionTopics": [
            null
          ],
          "telephoneNumbers": [
            {
              "number": "5"
            }
          ],
          "verified": true,
          "verticalType": {
            "description": "description_6",
            "displayName": "display_name_7",
            "id": "00000000-0000-4000-8000-000000000003"
          },
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage8.not"
            }
          ],
          "yearFounded": 2000
        },
        "createdAt": null,
        "destination": "1234131",
        "externalId": "1231",
        "id": "00000000-0000-4000-8000-000000000004",
        "messageBody": "message content",
        "metadata": {
          "different": "metadata"
        },
        "source": "2132131",
        "status": "RECEIVED",
        "timestamp": "2026-01-15T09:00:00.000000",
        "type": "SMS",
        "updatedAt": "2026-01-15T09:00:01",
        "user": {
          "aboutMe": "this is my generic intro",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 9",
              "types": [
                "HOME"
              ],
              "zipCode": "12345"
            }
          ],
          "birthdate": "1990-01-15",
          "emails": [
            {
              "email": "test10@email.com"
            }
          ],
          "firstName": "4john",
          "id": "00000000-0000-4000-8000-000000000005",
          "interests": [
            {
              "description": null,
              "title": "Interest 11"
            }
          ],
          "lastName": "5doe",
          "metadata": {
            "test": "value"
          },
          "middleName": "ray",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm12.not"
            }
          ],
          "telephoneNumbers": [
            {
              "number": "13"
            }
          ],
          "timezone": "UTC",
          "username": "username14",
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage15.not"
            }
          ]
        }
      },
      {
        "company": {
          "aboutUs": "about us content",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 1",
              "types": [
                "HEADQUARTERS"
              ],
              "zipCode": "12345"
            }
          ],
          "brandName": "1brand-name",
          "emails": [
            {
              "email": "test2@email.com"
            }
          ],
          "id": "00000000-0000-4000-8000-000000000001",
          "legalName": "2legal-name",
          "logoUrl": "http://localhost:4566/logo_url?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=SOME_RANDOM_ACCESS_KEY%2F20260115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000",
          "metadata": {
            "test": "value"
          },
          "organizationType": {
            "displayName": "display_name_3",
            "id": "00000000-0000-4000-8000-000000000002"
          },
          "profileName": "3profile-name",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm4.not"
            }
          ],
          "specialties": [
            {
              "description": null,
              "title": "Telecommunications"
            }
          ],
          "subscriptionTopics": [
            null
          ],
          "telephoneNumbers": [
            {
              "number": "5"
            }
          ],
          "verified": true,
          "verticalType": {
            "description": "description_6",
            "displayName": "display_name_7",
            "id": "00000000-0000-4000-8000-000000000003"
          },
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage8.not"
            }
          ],
          "yearFounded": 2000
        },
        "createdAt": null,
        "destination": "1234132",
        "externalId": "1232",
        "id": "00000000-0000-4000-8000-000000000006",
        "messageBody": "message content",
        "metadata": {
          "different": "metadata"
        },
        "source": "2132132",
        "status": "RECEIVED",
        "timestamp": "2026-01-15T09:00:00.000000",
        "type": "SMS",
        "updatedAt": "2026-01-15T09:00:01",
        "user": {
          "aboutMe": "this is my generic intro",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 16",
              "types": [
                "HOME"
              ],
              "zipCode": "12345"
            }
          ],
          "birthdate": "1990-01-15",
          "emails": [
            {
              "email": "test17@email.com"
            }
          ],
          "firstName": "6john",
          "id": "00000000-0000-4000-8000-000000000007",
          "interests": [
            {
              "description": null,
              "title": "Interest 18"
            }
          ],
          "lastName": "7doe",
          "metadata": {
            "test": "value"
          },
          "middleName": "ray",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm19.not"
            }
          ],
          "telephoneNumbers": [
            {
              "number": "20"
            }
          ],
          "timezone": "UTC",
          "username": "username21",
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage22.not"
            }
          ]
        }
      },
      {
        "company": {
          "aboutUs": "about us content",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 1",
              "types": [
                "HEADQUARTERS"
              ],
              "zipCode": "12345"
            }
          ],
          "brandName": "1brand-name",
          "emails": [
            {
              "email": "test2@email.com"
            }
          ],
          "id": "00000000-0000-4000-8000-000000000001",
          "legalName": "2legal-name",
          "logoUrl": "http://localhost:4566/logo_url?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=SOME_RANDOM_ACCESS_KEY%2F20260115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000",
          "metadata": {
            "test": "value"
          },
          "organizationType": {
            "displayName": "display_name_3",
            "id": "00000000-0000-4000-8000-000000000002"
          },
          "profileName": "3profile-name",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm4.not"
            }
          ],
          "specialties": [
            {
              "description": null,
              "title": "Telecommunications"
            }
          ],
          "subscriptionTopics": [
            null
          ],
          "telephoneNumbers": [
            {
              "number": "5"
            }
          ],
          "verified": true,
          "verticalType": {
            "description": "description_6",
            "displayName": "display_name_7",
            "id": "00000000-0000-4000-8000-000000000003"
          },
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage8.not"
            }
          ],
          "yearFounded": 2000
        },
        "createdAt": null,
        "destination": "1234133",
        "externalId": "1233",
        "id": "00000000-0000-4000-8000-000000000008",
        "messageBody": "message content",
        "metadata": {
          "different": "metadata"
        },
        "source": "2132133",
        "status": "RECEIVED",
        "timestamp": "2026-01-15T09:00:00.000000",
        "type": "SMS",
        "updatedAt": "2026-01-15T09:00:01",
        "user": {
          "aboutMe": "this is my generic intro",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 23",
              "types": [
                "HOME"
              ],
              "zipCode": "12345"
            }
          ],
          "birthdate": "1990-01-15",
          "emails": [
            {
              "email": "test24@email.com"
            }
          ],
          "firstName": "8john",
          "id": "00000000-0000-4000-8000-000000000009",
          "interests": [
            {
              "description": null,
              "title": "Interest 25"
            }
          ],
          "lastName": "9doe",
          "metadata": {
            "test": "value"
          },
          "middleName": "ray",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm26.not"
            }
          ],
          "telephoneNumbers": [
            {
              "number": "27"
            }
          ],
          "timezone": "UTC",
          "username": "username28",
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage29.not"
            }
          ]
        }
      },
      {
        "company": {
          "aboutUs": "about us content",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 1",
              "types": [
                "HEADQUARTERS"
              ],
              "zipCode": "12345"
            }
          ],
          "brandName": "1brand-name",
          "emails": [
            {
              "email": "test2@email.com"
            }
          ],
          "id": "00000000-0000-4000-8000-000000000001",
          "legalName": "2legal-name",
          "logoUrl": "http://localhost:4566/logo_url?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=SOME_RANDOM_ACCESS_KEY%2F20260115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000",
          "metadata": {
            "test": "value"
          },
          "organizationType": {
            "displayName": "display_name_3",
            "id": "00000000-0000-4000-8000-000000000002"
          },
          "profileName": "3profile-name",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm4.not"
            }
          ],
          "specialties": [
            {
              "description": null,
              "title": "Telecommunications"
            }
          ],
          "subscriptionTopics": [
            null
          ],
          "telephoneNumbers": [
            {
              "number": "5"
            }
          ],
          "verified": true,
          "verticalType": {
            "description": "description_6",
            "displayName": "display_name_7",
            "id": "00000000-0000-4000-8000-000000000003"
          },
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage8.not"
            }
          ],
          "yearFounded": 2000
        },
        "createdAt": null,
        "destination": "1234134",
        "externalId": "1234",
        "id": "00000000-0000-4000-8000-000000000010",
        "messageBody": "message content",
        "metadata": {
          "different": "metadata"
        },
        "source": "2132134",
        "status": "RECEIVED",
        "timestamp": "2026-01-15T09:00:00.000000",
        "type": "SMS",
        "updatedAt": "2026-01-15T09:00:01",
        "user": {
          "aboutMe": "this is my generic intro",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 30",
              "types": [
                "HOME"
              ],
              "zipCode": "12345"
            }
          ],
          "birthdate": "1990-01-15",
          "emails": [
            {
              "email": "test31@email.com"
            }
          ],
          "firstName": "10john",
          "id": "00000000-0000-4000-8000-000000000011",
          "interests": [
            {
              "description": null,
              "title": "Interest 32"
            }
          ],
          "lastName": "11doe",
          "metadata": {
            "test": "value"
          },
          "middleName": "ray",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm33.not"
            }
          ],
          "telephoneNumbers": [
            {
              "number": "34"
            }
          ],
          "timezone": "UTC",
          "username": "username35",
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage36.not"
            }
          ]
        }
      },
      {
        "company": {
          "aboutUs": "about us content",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 1",
              "types": [
                "HEADQUARTERS"
              ],
              "zipCode": "12345"
            }
          ],
          "brandName": "1brand-name",
          "emails": [
            {
              "email": "test2@email.com"
            }
          ],
          "id": "00000000-0000-4000-8000-000000000001",
          "legalName": "2legal-name",
          "logoUrl": "http://localhost:4566/logo_url?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=SOME_RANDOM_ACCESS_KEY%2F20260115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000",
          "metadata": {
            "test": "value"
          },
          "organizationType": {
            "displayName": "display_name_3",
            "id": "00000000-0000-4000-8000-000000000002"
          },
          "profileName": "3profile-name",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm4.not"
            }
          ],
          "specialties": [
            {
              "description": null,
              "title": "Telecommunications"
            }
          ],
          "subscriptionTopics": [
            null
          ],
          "telephoneNumbers": [
            {
              "number": "5"
            }
          ],
          "verified": true,
          "verticalType": {
            "description": "description_6",
            "displayName": "display_name_7",
            "id": "00000000-0000-4000-8000-000000000003"
          },
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage8.not"
            }
          ],
          "yearFounded": 2000
        },
        "createdAt": null,
        "destination": "1234135",
        "externalId": "1235",
        "id": "00000000-0000-4000-8000-000000000012",
        "messageBody": "message content",
        "metadata": {
          "different": "metadata"
        },
        "source": "2132135",
        "status": "RECEIVED",
        "timestamp": "2026-01-15T09:00:00.000000",
        "type": "SMS",
        "updatedAt": "2026-01-15T09:00:01",
        "user": {
          "aboutMe": "this is my generic intro",
          "addresses": [
            {
              "city": "test city",
              "country": "United States",
              "state": "Alabama",
              "street": "test street 37",
              "types": [
                "HOME"
              ],
              "zipCode": "12345"
            }
          ],
          "birthdate": "1990-01-15",
          "emails": [
            {
              "email": "test38@email.com"
            }
          ],
          "firstName": "12john",
          "id": "00000000-0000-4000-8000-000000000013",
          "interests": [
            {
              "description": null,
              "title": "Interest 39"
            }
          ],
          "lastName": "13doe",
          "metadata": {
            "test": "value"
          },
          "middleName": "ray",
          "socialNetworks": [
            {
              "type": "FACEBOOK",
              "url": "https://test-sm40.not"
            }
          ],
          "telephoneNumbers": [
            {
              "number": "41"
            }
          ],
          "timezone": "UTC",
          "username": "username42",
          "webpages": [
            {
              "type": "WEBPAGE",
              "url": "https://test-webpage43.not"
            }
          ]
        }
      }
    ]
  },
  "errors": [
    {
      "locations": [
        {
          "column": 9,
          "line": 78
        }
      ],
      "message": "Cannot return null for non-nullable field",
      "path": [
        "optOutRequests",
        4,
        "company",
        "subscriptionTopics",
        0,
        "id"
      ]
    },
    {
      "locations": [
        {
          "column": 9,
          "line": 78
        }
      ],
      "message": "Cannot return null for non-nullable field",
      "path": [
        "optOutRequests",
        3,
        "company",
        "subscriptionTopics",
        0,
        "id"
      ]
    },
    {
      "locations": [
        {
          "column": 9,
          "line": 78
        }
      ],
      "message": "Cannot return null for non-nullable field",
      "path": [
        "optOutRequests",
        2,
        "company",
        "subscriptionTopics",
        0,
        "id"
      ]
    },
    {
      "locations": [
        {
          "column": 9,
          "line": 78
        }
      ],
      "message": "Cannot return null for non-nullable field",
      "path": [
        "optOutRequests",
        1,
        "company",
        "subscriptionTopics",
        0,
        "id"
      ]
    },
    {
      "locations": [
        {
          "column": 9,
          "line": 78
        }
      ],
      "message": "Cannot return null for non-nullable field",
      "path": [
        "optOutRequests",
        0,
        "company",
        "subscriptionTopics",
        0,
        "id"
      ]
    }
  ]
}
```