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

# List watched branches

`GET /api/v1alpha/watched_branches`

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

---

[API](https://skmtc.net/hail-is/apis/hail-ci-service.md) · [All operations](https://skmtc.net/hail-is/apis/hail-ci-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hail-is/hail-ci-service/versions/37d6dddb7b5a/schema)
