> ## 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 Button Layouts

> List button layouts for a tenant. Supports pagination and substring search by name.



## OpenAPI

````yaml https://api.voxo.co/v2/docs/openapi.json get /v2/admin/button-layouts/
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/button-layouts/:
    get:
      tags:
        - Button Layouts
      summary: List Button Layouts
      description: >-
        List button layouts for a tenant. Supports pagination and substring
        search by name.
      parameters:
        - schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
          in: query
          name: tenantId
          required: true
          description: Tenant ID to list layouts for
        - schema:
            type: string
            minLength: 1
            maxLength: 255
          in: query
          name: name
          required: false
          description: Optional substring search on name
        - schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
          in: query
          name: page
          required: false
          description: Page number
        - schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
          in: query
          name: recordsPerPage
          required: false
          description: Number of records per page
      responses:
        '200':
          description: Paginated button layouts
          content:
            application/json:
              schema:
                type: object
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          exclusiveMinimum: 0
                          description: Button Layout ID
                        tenantId:
                          type: number
                          exclusiveMinimum: 0
                          description: Tenant ID
                        name:
                          type: string
                          minLength: 1
                          maxLength: 255
                          description: Button layout name
                        startKey:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                          description: First button key
                        endKey:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                          description: Last button key
                      required:
                        - id
                        - tenantId
                        - name
                        - startKey
                        - endKey
                      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
        '403':
          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

````