> ## Documentation Index > Fetch the complete documentation index at: https://xata.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # List all branches > Retrieves a list of all branches within the specified project, including their metadata, region, and access settings. ## OpenAPI ````yaml https://api.xata.tech/openapi.json get /organizations/{organizationID}/projects/{projectID}/branches openapi: 3.0.0 info: title: Xata API description: Xata API version: '1.0' contact: name: help@xata.io servers: - url: https://api.xata.tech description: Xata API security: [] tags: - name: Organizations description: Operations for creating, retrieving, updating, and deleting organizations x-displayName: Organizations - name: Users description: Operations for managing user accounts and profiles x-displayName: Users - name: API Keys description: >- Operations for managing API keys, including creation, listing, and deletion x-displayName: API Keys - name: Marketplace description: Operations for linking user accounts to cloud marketplace subscriptions x-displayName: Marketplace - name: Billing description: Internal organization billing operations x-displayName: Billing - name: Gateway description: >- PostgreSQL connectivity via HTTP SQL, WebSocket wire protocol proxy, and native wire protocol. x-displayName: Gateway - name: MCP description: Model Context Protocol endpoint. x-displayName: MCP - name: Projects Webhooks x-displayName: Projects Webhooks - name: Projects description: >- Operations for creating, retrieving, updating, and deleting projects within an organization x-displayName: Projects - name: Branches description: >- Operations for managing database branches within projects, including creation, configuration, and deletion x-displayName: Branches - name: GitHub App description: Operations for managing GitHub App installation mappings x-displayName: GitHub App - name: Metrics description: Operations for retrieving observability metrics for a branch x-displayName: Metrics - name: Logs description: Operations for retrieving log entries for a branch x-displayName: Logs - name: Vercel x-displayName: Vercel - name: Webhooks x-displayName: Webhooks externalDocs: url: https://xata.io/docs/api paths: /organizations/{organizationID}/projects/{projectID}/branches: summary: Branch Management description: Endpoints for listing and creating branches within a project. get: tags: - Branches summary: List all branches description: >- Retrieves a list of all branches within the specified project, including their metadata, region, and access settings. operationId: listBranches parameters: - name: organizationID in: path description: Unique identifier of the organization containing the project required: true schema: $ref: '#/components/schemas/OrganizationID' - name: projectID in: path description: Unique identifier of the project to list branches from required: true schema: type: string responses: '200': description: List of branches within the project content: application/json: schema: type: object properties: branches: description: Array of branch objects with their metadata type: array items: $ref: '#/components/schemas/BranchListMetadata' required: - branches '400': $ref: '#/components/responses/GenericError' '401': $ref: '#/components/responses/AuthorizationError' '404': $ref: '#/components/responses/GenericError' 5XX: description: Unexpected Error default: description: Unexpected Error security: - xata: - branch:read components: schemas: OrganizationID: title: OrganizationID type: string pattern: '[a-zA-Z0-9_-~:]+' x-oapi-codegen-extra-tags: validate: identifier BranchListMetadata: description: Metadata about a branch used when listing branches in a project type: object properties: id: description: Unique identifier for the branch type: string name: description: Human-readable name of the branch type: string description: description: Optional description of the branch purpose or contents type: string createdAt: description: Timestamp when the branch was created type: string format: date-time updatedAt: description: Timestamp when the branch was last updated type: string format: date-time parentID: description: >- Identifier of the parent branch if this is a derived branch, null otherwise type: string nullable: true region: description: Geographic region where the branch is deployed type: string publicAccess: description: Whether the branch allows public access without authentication type: boolean backupsEnabled: description: Whether the branch is in a region that supports backups type: boolean required: - id - name - createdAt - updatedAt - region - publicAccess - backupsEnabled responses: GenericError: description: Generic error response for most error conditions content: application/json: schema: type: object properties: id: description: Error identifier for tracking and debugging type: string message: description: Human-readable error message explaining the issue type: string required: - message AuthorizationError: description: Error response when authentication or authorization fails content: application/json: schema: type: object properties: id: description: Error identifier for tracking and debugging type: string message: description: >- Human-readable error message explaining the authentication or authorization issue type: string required: - message securitySchemes: xata: type: oauth2 flows: implicit: authorizationUrl: https://auth.xata.io/realms/xata/protocol/openid-connect/auth scopes: org:read: Read organization information org:write: Create and modify organizations keys:read: Read API keys keys:write: Create and manage API keys project:read: Read project information project:write: Create and modify projects branch:read: Read branch information branch:write: Create and modify branches metrics:read: Read metrics data logs:read: Read logs data credentials:read: Read credentials credentials:write: Rotate credentials marketplace:write: Register with cloud marketplaces ````