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

# List Phone Numbers

> List phone numbers for a tenant with optional filters



## OpenAPI

````yaml https://api.voxo.co/v2/docs/openapi.json get /v2/admin/phone-numbers/
openapi: 3.1.0
info:
  title: VOXO API
  description: VOXO Communication Platform API
  version: 2.0.0
servers:
  - url: https://api.voxo.co
security:
  - bearerAuth: []
paths:
  /v2/admin/phone-numbers/:
    get:
      tags:
        - Phone Numbers
      summary: List Phone Numbers
      description: List phone numbers for a tenant with optional filters
      parameters:
        - schema:
            type: string
            pattern: ^[1-9]\d*$
          in: query
          name: tenantId
          required: true
          description: Tenant ID
        - schema:
            type: string
            pattern: ^[1-9]\d*$
          in: query
          name: branchId
          required: false
          description: Branch ID
        - schema:
            type: string
            maxLength: 11
          in: query
          name: number
          required: false
          description: Phone number
        - schema:
            type: string
            maxLength: 255
          in: query
          name: query
          required: false
          description: Search by number, comment, or name
        - schema:
            type: string
          in: query
          name: fax
          required: false
          description: Search by fax (1 = yes, 0 = no)
        - schema:
            type: string
            enum:
              - '0'
              - '1'
          in: query
          name: inUse
          required: false
          description: Filter by use status (1 = in use, 0 = not in use)
        - schema:
            type: string
            maxLength: 50
          in: query
          name: sortBy
          required: false
          description: Sort column
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sortDirection
          required: false
          description: Sort direction
        - schema:
            type: string
            pattern: ^[1-9]\d*$
          in: query
          name: limit
          required: false
          description: Number of results per page
        - schema:
            default: 1
            type: integer
            minimum: 0
            maximum: 1
          in: query
          name: paginated
          required: false
          description: 1 = paginated response, 0 = full list
        - schema:
            type: number
          in: query
          name: page
          required: false
          description: Page number
        - schema:
            type: number
          in: query
          name: recordsPerPage
          required: false
          description: Records per page
      responses:
        '200':
          description: Paginated phone numbers
          content:
            application/json:
              schema:
                type: object
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: Phone number ID
                        number:
                          type: string
                          description: Phone number
                        registeredCNAM:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Registered caller ID name
                        tenantId:
                          type: number
                          description: Tenant ID
                        tenantName:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Tenant name
                        branchId:
                          anyOf:
                            - type: number
                            - type: 'null'
                          description: Branch ID
                        diCommentName:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Comment/description
                        recording:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Recording mode
                        fax:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Fax mode
                        faxEmail:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Fax email
                        faxStore:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Fax store setting
                        namePrefix:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Caller ID name prefix
                        unconditionalStatus:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Unconditional forwarding status
                        emailRecording:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Recording email address
                        storeAndForwardNumber:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Store and forward number
                        smsExtId:
                          anyOf:
                            - type: number
                            - type: 'null'
                          description: SMS extension ID
                        inUse:
                          type: number
                          description: >-
                            1 when the number has destination routing or is a
                            fax line
                      required:
                        - id
                        - number
                        - registeredCNAM
                        - tenantId
                        - branchId
                        - diCommentName
                        - recording
                        - fax
                        - faxEmail
                        - faxStore
                        - namePrefix
                        - unconditionalStatus
                        - emailRecording
                        - storeAndForwardNumber
                        - smsExtId
                        - inUse
                      additionalProperties: false
                    description: Phone number records
                  page:
                    type: number
                    description: Current page
                  maxPage:
                    type: number
                    description: Maximum page
                  totalRecords:
                    type: number
                    description: Total records
                required:
                  - records
                  - page
                  - maxPage
                  - totalRecords
                additionalProperties: false
        '400':
          description: Error response
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  message:
                    type: string
                  code:
                    type: number
                  validationErrors:
                    type: array
                    items:
                      type: string
                required:
                  - name
                  - message
                  - code
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````