Skip to main content
Manja / GitHub

List branches

GET/repos/{owner}/{repo}/branches
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
Query Parameters
protected boolean
optional

Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.

per_page integer
optional

Results per page (max 100)

page integer
optional

Page number of the results to fetch.

Responses

application/json array[Short Branch object]

Response

Headers
Link string
Example:
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"
items Short Branch object

Short Branch

commit object
required
sha string
required
url string<uri>
required
name string
required
protected boolean
required
protection Branch Protection object
optional

Branch Protection

allow_deletions object
optional
enabled boolean
optional
allow_force_pushes object
optional
enabled boolean
optional
enabled boolean
optional
enforce_admins Protected Branch Admin Enforced object
optional

Protected Branch Admin Enforced

enabled boolean
required

Example: true

url string<uri>
required

Example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins

name string
optional

Example: "branch/with/protection"

protection_url string
optional
Example:
"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection"
required_conversation_resolution object
optional
enabled boolean
optional
required_linear_history object
optional
enabled boolean
optional
required_pull_request_reviews Protected Branch Pull Request Review object
optional

Protected Branch Pull Request Review

dismiss_stale_reviews boolean
required

Example: true

dismissal_restrictions object
optional
require_code_owner_reviews boolean
required

Example: true

required_approving_review_count integer
optional

Example: 2

minimum:1

maximum:6

url string<uri>
optional
Example:
https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions
required_signatures object
optional
enabled boolean
required

Example: true

url string<uri>
required

Example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures

required_status_checks Protected Branch Required Status Check object
optional

Protected Branch Required Status Check

contexts array
required
contexts_url string
optional
enforcement_level string
optional
strict boolean
optional
url string
optional
restrictions Branch Restriction Policy object
optional

Branch Restriction Policy

apps array
required
apps_url string<uri>
required
teams array
required
teams_url string<uri>
required
url string<uri>
required
users array
required
users_url string<uri>
required
url string
optional
protection_url string<uri>
optional
application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional