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

# List assigned branches

> List active branches assigned to the authenticated user.

Returns active branches assigned to the authenticated user.


## OpenAPI

````yaml GET /branches
openapi: 3.1.0
info:
  title: HMIS API
  version: 1.0.0
  description: >-
    Versioned API for HMIS foundation resources and laboratory/radiology
    integrations. All operations use Laravel Sanctum bearer tokens with a
    dedicated ability per operation.
servers:
  - url: https://jaliprohmis.derrickmugabwa.dev/api/v1
    description: HMIS staging API
security:
  - bearerAuth: []
tags:
  - name: Foundation
    description: Authenticated HMIS context and reference data.
  - name: Laboratory integration
    description: Analyzer worklists and result ingestion.
  - name: Radiology integration
    description: PACS worklists and study ingestion.
paths:
  /branches:
    get:
      tags:
        - Foundation
      summary: List assigned active branches
      description: >-
        Returns active branches assigned to the authenticated user. Requires
        `organization:read`.
      operationId: listBranches
      responses:
        '200':
          description: Assigned branches.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BranchCollectionResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    BranchCollectionResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Branch'
    Branch:
      type: object
      properties:
        id:
          type: integer
        organization_id:
          type: integer
        name:
          type: string
        code:
          type: string
        email:
          type:
            - string
            - 'null'
          format: email
        phone:
          type:
            - string
            - 'null'
        address:
          type:
            - string
            - 'null'
        is_active:
          type: boolean
        is_primary:
          type: boolean
    ErrorResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          example: Unauthenticated.
      additionalProperties: true
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Bearer token is valid but lacks the required ability.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum personal access token
      description: >-
        Paste a Sanctum personal access token generated by a HMIS super
        administrator. Use only a token with the ability required by the
        selected operation.

````