> ## 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 Virtual Receptionists

> List a tenant's virtual receptionists with pagination, search, and sorting



## OpenAPI

````yaml https://api.voxo.co/v2/docs/openapi.json get /v2/admin/virtual-receptionist/
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/virtual-receptionist/:
    get:
      tags:
        - Virtual Receptionist
      summary: List Virtual Receptionists
      description: >-
        List a tenant's virtual receptionists with pagination, search, and
        sorting
      parameters:
        - 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
        - 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: tenantId
          required: true
          description: Tenant ID to list virtual receptionists for
        - schema:
            type: string
            pattern: ^[1-9]\d*$
          in: query
          name: branchId
          required: false
          description: Branch ID to filter by
        - schema:
            type: string
            maxLength: 255
          in: query
          name: query
          required: false
          description: Search by name
      responses:
        '200':
          description: Paginated virtual receptionist list
          content:
            application/json:
              schema:
                type: object
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        tenantId:
                          anyOf:
                            - type: number
                            - type: 'null'
                        name:
                          anyOf:
                            - type: string
                            - type: 'null'
                        timeout:
                          anyOf:
                            - type: number
                            - type: 'null'
                        loopOnTimeout:
                          anyOf:
                            - type: string
                            - type: 'null'
                        loopOnWrongKeyPress:
                          anyOf:
                            - type: string
                            - type: 'null'
                        loopPlayMessageOnce:
                          anyOf:
                            - type: string
                            - type: 'null'
                        allowExtensionDialing:
                          anyOf:
                            - type: string
                            - type: 'null'
                        maxLoops:
                          anyOf:
                            - type: number
                            - type: 'null'
                        enableSpeechDetect:
                          anyOf:
                            - type: number
                            - type: 'null'
                        announcements:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                              name:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              description:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              active:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                              tenantId:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                              mediaFileId:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                              startDate:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              endDate:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              order:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                            required:
                              - id
                              - name
                              - description
                              - active
                              - tenantId
                              - mediaFileId
                              - startDate
                              - endDate
                              - order
                            additionalProperties: {}
                        branchId:
                          anyOf:
                            - type: number
                            - type: 'null'
                          description: Branch ID (self-healed to default)
                      required:
                        - id
                        - tenantId
                        - name
                        - timeout
                        - loopOnTimeout
                        - loopOnWrongKeyPress
                        - loopPlayMessageOnce
                        - allowExtensionDialing
                        - maxLoops
                        - enableSpeechDetect
                        - branchId
                      additionalProperties: {}
                      description: Virtual receptionist list item
                  page:
                    type: number
                  maxPage:
                    type: number
                  totalRecords:
                    type: number
                required:
                  - records
                  - page
                  - maxPage
                  - totalRecords
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````