---
title: "List Opted Out Numbers"
method: GET
path: "/restapi/v1.0/account/{accountId}/a2p-sms/opt-outs"
tags: ["High Volume SMS"]
---

# List Opted Out Numbers

`GET /restapi/v1.0/account/{accountId}/a2p-sms/opt-outs`

## Request

- Base URL: `https://platform.ringcentral.com`
- URL: `https://platform.ringcentral.com/restapi/v1.0/account/{accountId}/a2p-sms/opt-outs`
- Auth: OAuth 2
  - Authorization code: `https://platform.ringcentral.com/restapi/oauth/authorize`
  - Token URL: `https://platform.ringcentral.com/restapi/oauth/token`
- TypeScript: <https://skmtc.dev/ringcentral/apis/ringcentral-api/docs/restapi/v1.0/account/:accountId/a2p-sms/opt-outs/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the list of numbers opted out from the account. The list
can be filtered by `to`/`from` phone number query parameters. Specifying `text/csv`
in the `Accept` header lets download the data in the CSV format.

## Path parameters

- `accountId` string, required

## Query parameters

- `from` string
- `to` string
- `status` 'optout' | 'optin' | 'all'
- `pageToken` string
- `perPage` integer

## Response `200`

Successful response

- OptOutListResponse: The list of opt outs
  - `records` OptOutResponse[]: List of individual opt-out number records
    - `from` string: Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the recipient has opted out
    - `to` string: Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format which is opted out
    - `status` 'OptIn' | 'OptOut': Status of a phone number
    - `source` 'Recipient' | 'Account' | 'Upstream' | 'Carrier'
  - `paging` PagingResource: Pagination details
    - `pageToken` string: Page token of the current response list
    - `perPage` integer: Number of records per page
    - `firstPageToken` string: First page token of the current filter criteria
    - `previousPageToken` string: Previous page token of the current filter criteria
    - `nextPageToken` string: Next page token of the current filter criteria

## Other responses

- `400`: Invalid Request
- `401`: Unauthorized
- `404`: No resource found for the account
- `500`: Service Unavailable

---

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