> ## 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 Phonebooks

> List phonebooks for a tenant with pagination. Optional `query` filters by name (LIKE). `paginated=0` returns the full list.



## OpenAPI

````yaml https://api.voxo.co/v2/docs/openapi.json get /v2/admin/phonebooks/
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/phonebooks/:
    get:
      tags:
        - Phonebooks
      summary: List Phonebooks
      description: >-
        List phonebooks for a tenant with pagination. Optional `query` filters
        by name (LIKE). `paginated=0` returns the full list.
      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
            pattern: ^[1-9]\d*$
          in: query
          name: tenantId
          required: true
          description: Tenant ID
        - schema:
            type: string
            maxLength: 50
          in: query
          name: query
          required: false
          description: Filter by phonebook name (LIKE)
      responses:
        '200':
          description: Paginated phonebooks
          content:
            application/json:
              schema:
                type: object
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: Phonebook ID
                        tenantId:
                          type: number
                          description: Tenant ID
                        name:
                          type: string
                          description: Phonebook name
                        includeExt:
                          type: string
                          description: Whether tenant extensions are included
                        provisioning:
                          type: number
                          description: Provisioning flag (1/0)
                      required:
                        - id
                        - tenantId
                        - name
                        - includeExt
                        - provisioning
                      additionalProperties: false
                  page:
                    type: number
                  maxPage:
                    type: number
                  totalRecords:
                    type: number
                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

````