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

# List branches

`GET /v1/branches`

## Request

- Base URL: `https://blobsrus.omniapp.co/api`
- URL: `https://blobsrus.omniapp.co/api/v1/branches`
- Auth: HTTP bearer

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

## Query parameters

- `cursor` string
- `pageSize` integer
- `sortField` 'updatedAt' | 'createdAt' | 'name'
- `sortDirection` 'asc' | 'desc'
- `userId` string, uuid

## Response `200`

One page of the branches the caller may see, most recently updated first by default.

- object
  - `pageInfo` PageInfo, required: Pagination information for paginated responses.
    - `hasNextPage` boolean: Indicates if there are more records available.
    - `nextCursor` string, nullable: Cursor for the next page of results. `null` if no more results.
    - `pageSize` integer: Number of records per page.
    - `totalRecords` integer: Total number of records matching the query.
  - `records` BranchSummary[], required
    - `id` string, uuid, required: The organization-wide branch ID.
    - `name` string, required: The branch's name.
    - `description` string: The branch's description, if one was set.
    - `openToViewers` boolean, required: 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` string, date-time, required: When the branch was created.
    - `updatedAt` string, date-time, required: When the branch was last updated.

## Other responses

- `400`: Bad Request Possible error messages: - `cursor`, `pageSize`, `sortField`, or `sortDirection` is invalid - An Organization API key was used without a `userId`
- `403`: A Personal Access Token was used with a `userId` naming a different member.
- `429`: Too Many Requests - Rate limit exceeded (60 requests/minute)
- `500`: Internal Server Error

## Changes

- **2026-11-03** `43290040f88f`: 1 info
  - endpoint added

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

---

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