---
title: "List watched branches"
method: GET
path: "/api/v1alpha/watched_branches"
tags: ["PRs"]
---

# List watched branches

`GET /api/v1alpha/watched_branches`

## Request

- Base URL: `{{ base_url }}`
- URL: `{{ base_url }}/api/v1alpha/watched_branches`
- Auth: none declared

Returns all branches CI is monitoring, plus the current freeze status.

## Response `200`

Watched branches retrieved successfully

- WatchedBranchesResponse
  - `branches` WatchedBranchSummary[]
    - `branch` string: Branch name (e.g. main). Use this as the {branch} path parameter.
    - `branch_fqn` string: Fully-qualified branch ref (e.g. hail-is/hail:main).
    - `repo` string: Repository (e.g. hail-is/hail)
    - `sha` string, nullable: Current HEAD SHA
    - `deploy_state` string, nullable: Latest deploy state
    - `deploy_batch_id` integer, nullable: Latest deploy batch ID
    - `n_prs` integer: Number of active PRs
    - `merge_candidate` string, nullable: Current merge candidate PR (eg pr-123)
  - `frozen` boolean: Whether merges and deploys are frozen

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

## Changes

- **2026-07-30** `37d6dddb7b5a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hail-is/apis/hail-ci-service/changes/api/v1alpha/watched_branches/get.md)

---

[API](https://skmtc.dev/hail-is/apis/hail-ci-service.md) - [All operations](https://skmtc.dev/hail-is/apis/hail-ci-service/llms.txt) - [OpenAPI document](https://skmtc.dev/hail-is/apis/hail-ci-service/revisions/a60fc5e80878?raw)