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

> List branches for a tenant with optional pagination and name filter



## OpenAPI

````yaml https://api.voxo.co/v2/docs/openapi.json get /v2/admin/branches/
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/branches/:
    get:
      tags:
        - Branches
      summary: List Branches
      description: List branches for a tenant with optional pagination and name filter
      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
          in: query
          name: query
          required: false
          description: Search branches by name
        - schema:
            type: string
          in: query
          name: name
          required: false
          description: Filter branches by name
        - schema:
            type: number
          in: query
          name: tenantId
          required: true
          description: Tenant ID to list branches for
      responses:
        '200':
          description: Branch list or paginated branch list
          content:
            application/json:
              schema:
                anyOf:
                  - type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: Branch ID
                        tenantId:
                          type: number
                          description: Tenant ID
                        name:
                          type: string
                          description: Branch name
                        default:
                          type: number
                          description: Whether this is the default branch (1 = yes, 0 = no)
                        timezone:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: IANA timezone identifier
                      required:
                        - id
                        - tenantId
                        - name
                        - default
                        - timezone
                      additionalProperties: false
                  - type: object
                    properties:
                      records:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                              description: Branch ID
                            tenantId:
                              type: number
                              description: Tenant ID
                            name:
                              type: string
                              description: Branch name
                            default:
                              type: number
                              description: >-
                                Whether this is the default branch (1 = yes, 0 =
                                no)
                            timezone:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: IANA timezone identifier
                          required:
                            - id
                            - tenantId
                            - name
                            - default
                            - timezone
                          additionalProperties: false
                      page:
                        type: number
                      maxPage:
                        type: number
                      totalRecords:
                        type: number
                    required:
                      - records
                      - page
                      - maxPage
                      - totalRecords
                    additionalProperties: false
        '400':
          description: Validation 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
                  - validationErrors
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````