> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clerk.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# List opt-outs

> Returns a paginated list of opt-outs for the active team, newest first.



## OpenAPI

````yaml /swagger.yml get /public/v1/opt-outs
openapi: 3.0.0
info:
  title: Public API Docs
  description: Clerk Public API
  version: '1.0'
  contact: {}
servers:
  - url: https://web-api.clerk.chat
    description: Production server
  - url: http://localhost:3000
    description: Production server
security: []
tags: []
paths:
  /public/v1/opt-outs:
    get:
      tags:
        - Opt-outs
      summary: List opt-outs
      description: Returns a paginated list of opt-outs for the active team, newest first.
      operationId: PublicOptOutsController_findAll
      parameters:
        - name: limit
          in: query
          required: false
          description: Number of items to return (max 50)
          example: 10
          schema:
            type: number
        - name: page
          in: query
          required: false
          description: Page number
          example: 1
          schema:
            type: number
      responses:
        '200':
          description: A paginated list of opt-outs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOptOutsResponse'
        '400':
          description: Invalid request body
        '401':
          description: Unauthorized request
        '403':
          description: You do not have permission to access this resource
        '404':
          description: Resource not found
        '422':
          description: Invalid request parameters
        '429':
          description: Too many requests for this resource
        '500':
          description: Internal server error
      security:
        - api_key: []
components:
  schemas:
    PaginatedOptOutsResponse:
      type: object
      required:
        - data
        - total
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OptOutObject'
        links:
          type: object
          properties:
            next:
              type: string
              description: The URL for the next page
            prev:
              type: string
              description: The URL for the previous page
            self:
              type: string
              description: The URL for the current page
        total:
          type: number
          description: The total number of opt-outs
          example: 1
    OptOutObject:
      type: object
      required:
        - id
        - identifier
        - inboxId
        - reason
        - channel
        - createdAt
      properties:
        id:
          type: string
          description: The ID of the resource
          example: 00000000-0000-0000-0000-000000000000
          readOnly: true
        identifier:
          type: string
          description: Opted-out phone number in E.164 format
          example: '+14155550100'
        inboxId:
          type: string
          description: >-
            Inbox ID when the opt-out is inbox-scoped; null for a team-wide
            opt-out
          example: 00000000-0000-0000-0000-000000000000
          readOnly: true
          nullable: true
        reason:
          type: string
          description: Reason for the opt-out, if provided
          example: Customer requested via support
          nullable: true
        channel:
          type: string
          description: Channel that produced the opt-out
          enum:
            - call
            - sms
            - amb
          example: sms
        createdAt:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00.000Z'
          readOnly: true
          description: The date and time the resource was created
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: apiKey

````