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

# List branches

> List branches in a collection.



## OpenAPI

````yaml get /collections/{collectionName}/branches
openapi: 3.1.1
info:
  title: LambdaDB API
  summary: LambdaDB Open API Spec
  version: 1.1.1
servers:
  - url: https://{projectHost}
    description: LambdaDB API endpoints
    variables:
      projectHost:
        description: The project-scoped URL of the API
        default: api.lambdadb.ai/projects/example-project
security: []
tags:
  - name: collections
    description: Create, describe, configure, list, and delete collections.
  - name: versioning
    description: Manage branches, tags, and aliases within a collection.
  - name: collections.docs
    description: Write, fetch, list, and bulk upload documents.
paths:
  /collections/{collectionName}/branches:
    get:
      tags:
        - versioning
      summary: List Branches
      description: List branches in a collection.
      operationId: listBranches
      parameters:
        - $ref: '#/components/parameters/CollectionName'
      responses:
        '200':
          description: Branch list.
          content:
            application/json:
              schema:
                type: object
                properties:
                  branches:
                    type: array
                    items:
                      $ref: '#/components/schemas/BranchDetails'
                required:
                  - branches
              examples:
                example:
                  value:
                    branches:
                      - name: candidate
                        parentBranch:
                          branchId: main-branch-id
                          name: main
                        createdAt: 1788336000000
                        headSnapshot:
                          snapshotId: snapshot-id
                          snapshotCommittedAt: 1788335940000
                        parentSnapshot:
                          snapshotId: snapshot-id
                          snapshotCommittedAt: 1788335940000
                      - name: main
                        parentBranch: null
                        createdAt: 1788335800000
                        headSnapshot:
                          snapshotId: snapshot-id
                          snapshotCommittedAt: 1788335940000
                        parentSnapshot: null
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
              examples:
                example:
                  summary: Example response for bad request
                  value:
                    message: Invalid request
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthenticated'
              examples:
                example:
                  summary: Example response for authentication failure
                  value:
                    message: Authentication failed
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests'
              examples:
                example:
                  summary: Example response for too many requests
                  value:
                    message: Too many requests
          headers:
            Retry-After:
              description: >-
                Optional retry delay in seconds. Not present on every 429
                response.
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
              examples:
                example:
                  summary: Example response for internal server error
                  value:
                    message: Internal server error
        '502':
          $ref: '#/components/responses/BadGateway'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      security:
        - ProjectApiKey: []
components:
  parameters:
    CollectionName:
      in: path
      name: collectionName
      description: Collection name.
      required: true
      schema:
        type: string
  schemas:
    BranchDetails:
      title: BranchDetails
      type: object
      properties:
        name:
          type: string
        parentBranch:
          description: >-
            Fixed identity and name of the direct source branch, even when its
            selected snapshot originated on an ancestor or its head was empty.
            Explicitly null for main or when no parent was recorded. Historical
            metadata only: it does not prevent parent deletion, and recreating
            the parent's name does not change this identity.
          anyOf:
            - $ref: '#/components/schemas/ParentBranchDetails'
            - type: 'null'
        headSnapshot:
          description: Current committed head. Explicitly null for an empty branch.
          anyOf:
            - $ref: '#/components/schemas/SnapshotDetails'
            - type: 'null'
        parentSnapshot:
          description: >-
            Fixed snapshot from which the branch was created, not the previous
            head. Explicitly null for main and branches created from an empty
            source, even after their head advances. This metadata does not
            extend snapshot retention.
          anyOf:
            - $ref: '#/components/schemas/SnapshotDetails'
            - type: 'null'
        createdAt:
          type: integer
          format: int64
          description: Branch creation time as Unix epoch milliseconds.
      required:
        - name
        - parentBranch
        - headSnapshot
        - parentSnapshot
        - createdAt
    BadRequest:
      title: BadRequest
      type: object
      properties:
        message:
          type: string
    Unauthenticated:
      title: Unauthenticated
      type: object
      properties:
        message:
          type: string
    TooManyRequests:
      title: TooManyRequests
      type: object
      properties:
        message:
          type: string
    InternalServerError:
      title: InternalServerError
      type: object
      properties:
        message:
          type: string
    ParentBranchDetails:
      title: ParentBranchDetails
      type: object
      properties:
        branchId:
          type: string
          description: Identity of the direct source branch at creation time.
        name:
          type: string
          description: Name of the direct source branch at creation time.
      required:
        - branchId
        - name
    SnapshotDetails:
      title: SnapshotDetails
      type: object
      properties:
        snapshotId:
          type: string
          description: Immutable snapshot identity.
        snapshotCommittedAt:
          type: integer
          format: int64
          description: >-
            Snapshot commit time as Unix epoch milliseconds, distinct from ref
            creation time and collection dataUpdatedAt.
      required:
        - snapshotId
        - snapshotCommittedAt
    ResourceNotFound:
      title: ResourceNotFound
      type: object
      properties:
        message:
          type: string
    MessageResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
  responses:
    ResourceNotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceNotFound'
          examples:
            example:
              summary: Example response for resource not found
              value:
                message: Resource not found
    BadGateway:
      description: >-
        Unexpected downstream failure. A failed write response may leave its
        outcome uncertain.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ServiceUnavailable:
      description: >-
        Transient catalog or storage dependency failure. Use bounded retries
        where the operation permits.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    GatewayTimeout:
      description: >-
        Gateway request deadline exceeded. A write may have been applied; verify
        its outcome before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
  securitySchemes:
    ProjectApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Project API Key.
      x-speakeasy-example: <YOUR_PROJECT_API_KEY>

````