> ## Documentation Index > Fetch the complete documentation index at: https://docs.omni.co/llms.txt > Use this file to discover all available pages before exploring further. # List branches > List the branches the caller may see: - Branches they created that don't have changes - Branches with a model change on a model they can use branches on - Branches with a draft they can edit in a branch - Branches [open to viewers](/content/develop/branch-mode#opening-a-branch-to-viewers) that have a layer on a model the caller can read ## OpenAPI ````yaml /api/openapi.yaml get /v1/branches openapi: 3.1.0 info: title: Omni API description: > The Omni REST API provides programmatic access to your Omni instance for managing users, documents, queries, schedules, and more. version: 1.0.0 contact: name: Omni Support url: https://docs.omni.co servers: - url: https://{instance}.omniapp.co/api description: Production variables: instance: default: blobsrus description: Your production Omni instance subdomain - url: https://{instance}.playground.exploreomni.dev/api description: Playground variables: instance: default: blobsrus description: Your playground Omni instance subdomain security: - bearerAuth: [] - orgApiKey: [] tags: - name: Who Am I description: Inspect your own user permissions - name: AI description: AI-powered query generation - name: AI Credit Controls description: Manage organization-level AI credit usage - name: AI Credit Usage description: Monitor AI credit usage - name: AI Evals description: >- Manage prompt sets and runs used to score AI quality against curated prompt suites. - name: AI Model Suggestions description: Manage AI-generated suggestions for shared models - name: AI Routines description: >- Manage Routines, which are scheduled, recurring AI-powered tasks that run automatically on your data - name: Apps description: Draft and publish app documents. - name: App downloads description: Download apps as PNG, PDF, XLSX, or CSV files - name: Branches description: List branches and open or close them to Viewers and Restricted Queriers - name: Documents v2 description: > A draft-based workflow for creating and editing documents: create a document, patch a draft, then publish. - name: Documents description: Create, retrieve, and manage documents - name: API Tokens description: >- Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth grants) - name: IP Allowlist description: Manage the organization's IP allowlist - name: Connections description: Manage database connections - name: Connection environments description: Manage connection environments database connections - name: Color Palettes description: Manage custom chart color palettes - name: Content description: Unified content retrieval (documents and folders) - name: Content migration description: Export and import dashboards - name: Content validator description: Validate content against models and perform find/replace operations - name: Dashboard downloads description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files - name: Dashboard filters and controls description: Read and update dashboard filter and control default values - name: dbt description: Manage dbt configuration for connections - name: Document favorites description: Favorite and unfavorite documents - name: Document labels description: Apply and manage labels on documents - name: Document permissions description: Manage document-level access - name: Embed description: Manage embed sessions - name: Labels description: | Manage labels in the organization - name: Folders description: Create and organize content folders - name: Folder favorites description: Favorite and unfavorite folders - name: Folder labels description: Apply and manage labels on folders - name: Folder permissions description: Manage folder-level access - name: Jobs description: Check status of asynchronous jobs - name: Models description: Create and manage data models - name: Model branches description: Manage model branches and merge changes - name: Model git configuration description: Manage git configuration for shared models - name: Queries description: Execute workbook queries - name: Schedules description: Create and manage scheduled tasks - name: Schedule recipients description: Manage schedule recipients - name: Schema refresh schedules description: Manage automated schema refresh schedules for connections - name: Skills description: >- Manage skills, the saved slash-command instructions the Omni AI assistant runs - name: Topics description: Retrieve topic information from models - name: Uploads description: Manage file uploads - name: Users description: Manage users - name: User attributes description: Manage user attribute definitions - name: User groups description: Manage user groups - name: User model roles description: Manage model and connection role assignments for users - name: User group model roles description: Manage model and connection role assignments for user groups - name: Uploads description: Manage CSV and spreadsheet uploads paths: /v1/branches: get: tags: - Branches summary: List branches description: > List the branches the caller may see: - Branches they created that don't have changes - Branches with a model change on a model they can use branches on - Branches with a draft they can edit in a branch - Branches [open to viewers](/content/develop/branch-mode#opening-a-branch-to-viewers) that have a layer on a model the caller can read operationId: listBranches parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/pageSize' - name: sortField in: query required: false schema: type: string enum: - updatedAt - createdAt - name default: updatedAt description: Field to sort by. - $ref: '#/components/parameters/sortDirection' - $ref: '#/components/parameters/userId' responses: '200': description: >- One page of the branches the caller may see, most recently updated first by default. content: application/json: schema: type: object properties: pageInfo: $ref: '#/components/schemas/PageInfo' records: type: array items: $ref: '#/components/schemas/BranchSummary' required: - pageInfo - records example: pageInfo: hasNextPage: false nextCursor: null pageSize: 20 totalRecords: 1 records: - id: 123e4567-e89b-12d3-a456-426614174001 name: feature/new-metrics description: null openToViewers: false createdAt: '2026-01-15T10:00:00.000Z' updatedAt: '2026-01-20T14:30:00.000Z' '400': description: | Bad Request Possible error messages: - `cursor`, `pageSize`, `sortField`, or `sortDirection` is invalid - An Organization API key was used without a `userId` content: application/json: schema: $ref: '#/components/schemas/ApiError400' '403': description: >- A Personal Access Token was used with a `userId` naming a different member. content: application/json: schema: $ref: '#/components/schemas/ApiError403' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' security: - bearerAuth: [] components: parameters: cursor: name: cursor schema: type: string example: eyJpZCI6IjEyMzQ1In0 required: false description: | Cursor for pagination from previous response `nextCursor`. in: query pageSize: name: pageSize schema: type: integer minimum: 1 maximum: 100 default: 20 example: 20 required: false description: Number of results per page in: query sortDirection: name: sortDirection in: query required: false schema: type: string enum: - asc - desc description: | Direction for sorting results: - `asc` - Ascending order (A-Z, 0-9) - `desc` - Descending order (Z-A, 9-0) userId: name: userId schema: type: string format: uuid required: false description: > **Organization API key required.** The membership ID of the user to act as. in: query schemas: PageInfo: type: object description: Pagination information for paginated responses. properties: hasNextPage: type: boolean description: Indicates if there are more records available. nextCursor: type: string nullable: true description: Cursor for the next page of results. `null` if no more results. pageSize: type: integer description: Number of records per page. totalRecords: type: integer description: Total number of records matching the query. BranchSummary: type: object properties: id: type: string format: uuid description: The organization-wide branch ID. name: type: string description: The branch's name. description: type: string description: The branch's description, if one was set. openToViewers: type: boolean description: >- Whether Viewers and Restricted Queriers see this branch instead of production. See [Opening a branch to viewers](/content/develop/branch-mode#opening-a-branch-to-viewers). createdAt: type: string format: date-time description: When the branch was created. updatedAt: type: string format: date-time description: When the branch was last updated. required: - id - name - openToViewers - createdAt - updatedAt ApiError400: type: object properties: detail: type: string description: Human-readable error message describing what went wrong. status: type: integer description: HTTP status code of the error. example: 400 required: - detail - status ApiError403: type: object properties: detail: type: string description: Human-readable error message describing what went wrong. status: type: integer description: HTTP status code of the error. example: 403 required: - detail - status Error: type: object properties: error: type: string description: HTTP response code for the error example: message: type: string description: Detailed error description example: responses: TooManyRequests: description: Too Many Requests - Rate limit exceeded (60 requests/minute) content: application/json: schema: $ref: '#/components/schemas/Error' InternalServerError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Can be either an [Organization API Key](/api/authentication#organization-api-keys) or [Personal Access Token (PAT)](/api/authentication#token-types). Include in the `Authorization` header as: `Bearer YOUR_TOKEN` orgApiKey: type: http scheme: bearer bearerFormat: JWT description: > Requires an [Organization API Key](/api/authentication#organization-api-keys). Personal Access Tokens (PATs) are not supported for this endpoint. Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.