---
title: "Branch detail"
method: GET
path: "/{service}/{owner_username}/repos/{repo_name}/branches/{name}/"
tags: ["Branches"]
---

# Branch detail

`GET /{service}/{owner_username}/repos/{repo_name}/branches/{name}/`

## Request

- Base URL: `https://api.codecov.io/api/v2`
- URL: `https://api.codecov.io/api/v2/{service}/{owner_username}/repos/{repo_name}/branches/{name}/`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/codecov/apis/codecov-api/docs/:service/:owner_username/repos/:repo_name/branches/:name/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a single branch by name.
Includes head commit information embedded in the response.

## Path parameters

- `name` string, required
- `owner_username` string, required
- `repo_name` string, required
- `service` 'bitbucket' | 'bitbucket_server' | 'github' | 'github_enterprise' | 'gitlab' | 'gitlab_enterprise', required

## Response `200`

- BranchDetail
  - `name` string, required
  - `updatestamp` string, date-time, required
  - `head_commit` CommitDetail, required
    - `commitid` string, required
    - `message` string, required
    - `timestamp` string, date-time, required
    - `ci_passed` boolean, required
    - `author` Owner, required
      - `service` 'github' | 'gitlab' | 'bitbucket' | 'github_enterprise' | 'gitlab_enterprise' | 'bitbucket_server', required: * `github` - Github * `gitlab` - Gitlab * `bitbucket` - Bitbucket * `github_enterprise` - Github Enterprise * `gitlab_enterprise` - Gitlab Enterprise * `bitbucket_server` - Bitbucket Server
      - `username` string, nullable, required
      - `name` string, nullable, required
    - `branch` string, required
    - `totals` CommitTotals, required
      - `files` integer, required
      - `lines` integer, required
      - `hits` integer, required
      - `misses` integer, required
      - `partials` integer, required
      - `coverage` number, double, required
      - `branches` integer, required
      - `methods` integer, required
      - `sessions` integer, required
      - `complexity` number, double, required
      - `complexity_total` number, double, required
      - `complexity_ratio` number, double, required
      - `diff` integer, required
    - `state` 'complete' | 'pending' | 'error' | 'skipped', required: * `complete` - Complete * `pending` - Pending * `error` - Error * `skipped` - Skipped
    - `parent` string, required
    - `report` Report, required
      - `totals` ReportTotals, required
        - `files` integer, required
        - `lines` integer, required
        - `hits` integer, required
        - `misses` integer, required
        - `partials` integer, required
        - `coverage` number, double, required
        - `branches` integer, required
        - `methods` integer, required
        - `messages` integer, required
        - `sessions` integer, required
        - `complexity` number, double, required
        - `complexity_total` number, double, required
        - `complexity_ratio` number, double, required
        - `diff` unknown, required
      - `files` ReportFile, required
        - `name` string, required
        - `totals` ReportTotals, required
          - `files` integer, required
          - `lines` integer, required
          - `hits` integer, required
          - `misses` integer, required
          - `partials` integer, required
          - `coverage` number, double, required
          - `branches` integer, required
          - `methods` integer, required
          - `messages` integer, required
          - `sessions` integer, required
          - `complexity` number, double, required
          - `complexity_total` number, double, required
          - `complexity_ratio` number, double, required
          - `diff` unknown, required
        - `line_coverage` unknown[], required
          - unknown

---

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