---
title: "List branches"
method: GET
path: "/api/v1/branches"
tags: ["Branches"]
---

# List branches

`GET /api/v1/branches`

## Request

- Base URL: `https://omniapp.co` (the document declares no server; this is the origin it was published from)
- URL: `https://omniapp.co/api/v1/branches`
- Auth: HTTP bearer

Lists the branches the user may see, most recently updated first by default, a page at a time. A branch is visible when the user created it and it holds no changes yet, when it changes a model they may use branches on, when it holds a draft they may edit in a branch, or when it is open to viewers and holds a model they can read.

## Query parameters

- `cursor` string: Cursor for pagination (from previous response nextCursor)
- `pageSize` integer: Number of results per page (1-100, integer)
- `sortDirection` 'asc' | 'desc': Sort direction for results
- `sortField` 'updatedAt' | 'createdAt' | 'name': Field to sort results by
- `userId` string, uuid: User ID of the user to act as, as `userId` on other endpoints. Required with an organization API key; a user-scoped key may only name its own user.

## Response `200`

The visible branches

- BranchesListResponse
  - `pageInfo` PageInfo, required
    - `hasNextPage` boolean, required: Whether more results are available
    - `nextCursor` string, nullable, required: Cursor for fetching the next page
    - `pageSize` number, required: Number of results per page
    - `totalRecords` number, required: Total number of records matching the query
  - `records` BranchSummary[], required
    - `createdAt` string, date-time, required: When the branch was created
    - `description` string, nullable, required: Branch description
    - `id` string, uuid, required: Branch ID
    - `name` string, required: Branch name
    - `openToViewers` boolean, required: Whether Viewers and Restricted Queriers of its models see the branch instead of production
    - `updatedAt` string, date-time, required: When the branch was last updated

## Other responses

- `400`: An organization API key without userId
- `401`: Authentication required

## Changes

- **2026-10-27** `5775a7ba4b2f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/omniapp/apis/omni-api/changes/api/v1/branches/get.md)

---

[API](https://skmtc.dev/omniapp/apis/omni-api.md) - [All operations](https://skmtc.dev/omniapp/apis/omni-api/llms.txt) - [OpenAPI document](https://skmtc.dev/omniapp/apis/omni-api/revisions/76b40ebc2292?raw)