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

# Get phonesms suppressions



## OpenAPI

````yaml /openapi.json get /phone/sms-suppressions
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
paths:
  /phone/sms-suppressions:
    get:
      operationId: phone.listSmsSuppressions
      parameters:
        - name: cursor
          in: query
          schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
            description: Opaque cursor from a previous response to fetch the next page
          allowEmptyValue: true
          allowReserved: true
        - name: limit
          in: query
          schema:
            default: 20
            type: integer
            minimum: 1
            maximum: 100
            description: Maximum number of items to return per page (1–100, default 20)
          allowEmptyValue: true
          allowReserved: true
        - name: phoneNumber
          in: query
          schema:
            type: string
            description: >-
              Filter to a single recipient (a phone number is normalized to
              E.164; anything else is matched as given)
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier of the suppression entry
                        phoneNumber:
                          type: string
                          description: Suppressed recipient phone number (E.164)
                        agentId:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: >-
                            Agent the suppression is scoped to, or null when
                            workspace-wide
                        reason:
                          enum:
                            - STOP_KEYWORD
                            - MANUAL
                          type: string
                          description: >-
                            Why the number is suppressed (recipient texted STOP,
                            or manual admin entry)
                        source:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: >-
                            Free-form origin marker, e.g. 'inbound-stop-keyword'
                            or 'manual-admin-add'
                        createdAt:
                          type: string
                          format: date-time
                          description: When the suppression was recorded
                      required:
                        - id
                        - phoneNumber
                        - agentId
                        - reason
                        - source
                        - createdAt
                      description: >-
                        A suppressed SMS recipient — sends to it are refused
                        with RECIPIENT_OPTED_OUT until the recipient texts START
                        or the org owner unsuppresses
                    description: Suppression entries matching the query
                  pagination:
                    type: object
                    properties:
                      nextCursor:
                        anyOf:
                          - type: string
                            pattern: ^[cC][^\s-]{8,}$
                          - type: 'null'
                        description: >-
                          Cursor to pass as the `cursor` parameter to retrieve
                          the next page, or null if no more results
                      hasMore:
                        type: boolean
                        description: Whether additional pages of results are available
                    required:
                      - nextCursor
                      - hasMore
                    description: Pagination metadata for retrieving additional pages
                required:
                  - items
                  - pagination
                description: Paginated list of suppressed SMS recipients
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.