> ## Documentation Index > Fetch the complete documentation index at: https://docs.wavix.com/llms.txt > Use this file to discover all available pages before exploring further. # List opted-out phone numbers > Returns a paginated list of phone numbers that have opted out of receiving messages from the authenticated account. ## OpenAPI ````yaml https://wavix.github.io/wavix-openapi/wavix-api.yaml get /v3/messages/opt-outs openapi: 3.1.0 info: title: Wavix APIs description: >- Wavix provides robust APIs that let you integrate voice and text messaging features directly into your app. Send text, place calls, and access detailed reports programmatically. termsOfService: https://wavix.com/terms-and-conditions license: name: MIT identifier: MIT contact: name: Wavix url: https://wavix.com email: support@wavix.com version: '1.0' servers: - url: https://api.wavix.com description: https://api.wavix.com variables: {} security: - bearerAuth: [] tags: - name: SIP trunks description: SIP trunks - name: Buy description: Numbers - name: Cart description: Numbers - name: My numbers description: Numbers - name: Billing description: Billing, transactions, and invoices - name: Profile description: Account profile and customer information - name: CDRs description: Call detail records and call history - name: Speech Analytics description: Call transcription and speech analytics - name: SMS and MMS description: Messaging - name: Number Validator description: Phone number validation - name: Link shortener description: Short link and click metrics - name: 2FA description: Two-factor authentication - name: 10DLC description: 10DLC Campaigns and Brands - name: API Keys description: API key management - name: Call webhooks description: Webhook configuration for call events - name: Call control description: Programmable Voice - name: Call streaming description: Real-time call audio streaming over WebSocket - name: Call recording description: Call recording - name: Sub-accounts description: Sub-account management - name: Voice campaigns description: Outbound voice campaigns - name: Wavix Embeddable description: WebRTC embeddable widget paths: /v3/messages/opt-outs: get: tags: - SMS and MMS summary: List opted-out phone numbers description: >- Returns a paginated list of phone numbers that have opted out of receiving messages from the authenticated account. operationId: sms_and_mms_opt_outs_list parameters: - in: query name: sender_id schema: type: string description: Filters opt-outs by the Sender ID they apply to. example: MySender - in: query name: campaign_id schema: type: string description: Filters opt-outs by the 10DLC campaign ID they apply to. example: C123456 - in: query name: created_after schema: type: string format: date description: >- Returns opt-outs created on or after this date, in `YYYY-MM-DD` format. example: '2024-01-01' - in: query name: created_before schema: type: string format: date description: >- Returns opt-outs created on or before this date, in `YYYY-MM-DD` format. example: '2024-12-31' - in: query name: page schema: type: integer minimum: 1 description: Page number to retrieve. Minimum `1`, default `1`. example: 1 - in: query name: per_page schema: type: integer minimum: 1 maximum: 100 description: Number of records to return per page. Default `25`, maximum `100`. example: 25 responses: '200': description: Returns a paginated list of opted-out phone numbers. content: application/json: schema: $ref: '#/components/schemas/OptOutsListResponse' examples: default: value: items: - phone_number: '15551234567' sender_id: MySender campaign_id: null created_at: '2024-01-15T10:30:00Z' - phone_number: '15559876543' sender_id: null campaign_id: C123456 created_at: '2024-01-16T14:45:00Z' pagination: current_page: 1 per_page: 25 total: 2 total_pages: 1 '400': $ref: '#/components/responses/BadRequestErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '422': $ref: '#/components/responses/ValidationErrorResponse' deprecated: false security: - bearerAuth: - messages:read components: schemas: OptOutsListResponse: title: OptOutsListResponse type: object properties: items: type: array description: Opt-out records that match the request. items: $ref: '#/components/schemas/OptOutItem' pagination: $ref: '#/components/schemas/Pagination' OptOutItem: title: OptOutItem type: object properties: phone_number: type: string description: Opted-out phone number. example: '15551234567' sender_id: type: - string - 'null' description: >- Sender ID. Contains `null` if the phone number opted out of all messages. example: MySender campaign_id: type: - string - 'null' description: 10DLC campaign ID, if any. example: C123456 created_at: type: string format: date-time description: Opt-out date and time in ISO 8601 format. example: '2024-01-15T10:30:00Z' Pagination: title: Pagination required: - current_page - per_page - total - total_pages type: object additionalProperties: false properties: current_page: type: integer description: Current page number. format: int32 example: 2 per_page: type: integer description: Number of records per page. format: int32 example: 25 total: type: integer description: Total number of records. format: int32 example: 101 total_pages: type: integer description: Total number of pages. format: int32 example: 5 ValidationErrorResponse: title: ValidationErrorResponse type: object properties: success: type: boolean description: >- Indicates whether the request was successful. Always `false` for this error. example: false message: type: string description: >- Human-readable description naming the missing or invalid request parameter. example: Missing or invalid parameter ForbiddenErrorResponse: title: ForbiddenErrorResponse type: object properties: success: type: boolean description: >- Indicates whether the request was successful. Always `false` for this error. example: false message: type: string description: Human-readable description of why access is forbidden. example: The service is not provisioned for your account. responses: BadRequestErrorResponse: description: Request failed. Missing or invalid parameter headers: {} content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' ForbiddenErrorResponse: description: Request failed. The feature is disabled for your account. headers: {} content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorResponse' ValidationErrorResponse: description: Validation error headers: {} content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer description: > Wavix API key. Pass as `Authorization: Bearer `. Keys support per-resource scopes (none / read / write). See [Restricted keys and scopes](https://docs.wavix.com/api-reference/authentication#restricted-keys-and-scopes). ````