Get a branch

GET

/repos/{owner}/{repo}/branches/{branch}

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

branch

required

string

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

Responses

200

Response

application/json

Branch With Protection

Branch With Protection

object

name

required

string

commit

required

Commit

Commit

object

url

required

string format: uri

sha

required

string

node_id

required

string

html_url

required

string format: uri

comments_url

required

string format: uri

commit

required

object

url

required

string format: uri

author

required

Git User

Metaproperties for Git author/committer information.

object

name

string

email

string

date

string format: date-time

committer

required

Git User

Metaproperties for Git author/committer information.

object

name

string

email

string

date

string format: date-time

message

required

string

comment_count

required

integer

tree

required

object

sha

required

string

url

required

string format: uri

verification

Verification

object

verified

required

boolean

reason

required

string

payload

required

string

nullable

signature

required

string

nullable

verified_at

required

string

nullable

author

required

One of:

Simple User
Empty Object

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

committer

required

One of:

Simple User
Empty Object

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

parents

required

Array<object>

object

sha

required

string

url

required

string format: uri

html_url

string format: uri

stats

object

additions

integer

deletions

integer

total

integer

files

Array<object>

Diff Entry

Diff Entry

object

sha

required

string

nullable

filename

required

string

status

required

string

Allowed values: added removed modified renamed copied changed unchanged

additions

required

integer

deletions

required

integer

changes

required

integer

blob_url

required

string format: uri

raw_url

required

string format: uri

contents_url

required

string format: uri

patch

string

previous_filename

string

_links

required

object

html

required

string

self

required

string format: uri

protected

required

boolean

protection

required

Branch Protection

Branch Protection

object

url

string

enabled

boolean

required_status_checks

Protected Branch Required Status Check

Protected Branch Required Status Check

object

url

string

enforcement_level

string

contexts

required

Array<string>

checks

required

Array<object>

object

context

required

string

app_id

required

integer

nullable

contexts_url

string

strict

boolean

enforce_admins

Protected Branch Admin Enforced

Protected Branch Admin Enforced

object

url

required

string format: uri

enabled

required

boolean

required_pull_request_reviews

Protected Branch Pull Request Review

Protected Branch Pull Request Review

object

url

string format: uri

dismissal_restrictions

object

users

The list of users with review dismissal access.

Array<object>

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

teams

The list of teams with review dismissal access.

Array<object>

Team

Groups of organization members that gives permissions on specified repositories.

object

required

integer

node_id

required

string

name

required

string

slug

required

string

description

required

string

nullable

privacy

string

notification_setting

string

permission

required

string

permissions

object

pull

required

boolean

triage

required

boolean

push

required

boolean

maintain

required

boolean

admin

required

boolean

url

required

string format: uri

html_url

required

string format: uri

members_url

required

string

repositories_url

required

string format: uri

type

required

The ownership type of the team

string

Allowed values: enterprise organization

access_source

How the team’s access to the repository was granted. This property is only present when the team is returned in a repository context, such as GET /repos/{owner}/{repo}/teams.

string

Allowed values: direct organization enterprise

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

parent

required

Team Simple

Groups of organization members that gives permissions on specified repositories.

object

required

Unique identifier of the team

integer

node_id

required

string

url

required

URL for the team

string format: uri

members_url

required

string

name

required

Name of the team

string

description

required

Description of the team

string

nullable

permission

required

Permission that the team will have for its repositories

string

privacy

The level of privacy this team should have

string

notification_setting

The notification setting the team has set

string

html_url

required

string format: uri

repositories_url

required

string format: uri

slug

required

string

ldap_dn

Distinguished Name (DN) that team maps to within LDAP environment

string

type

required

The ownership type of the team

string

Allowed values: enterprise organization

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

apps

The list of apps with review dismissal access.

Array<object>

GitHub app

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

object

required

Unique identifier of the GitHub app

integer

slug

The slug name of the GitHub app

string

node_id

required

string

client_id

string

owner

required

One of:

Simple User
Enterprise

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

name

required

The name of the GitHub app

string

description

required

string

nullable

external_url

required

string format: uri

html_url

required

string format: uri

created_at

required

string format: date-time

updated_at

required

string format: date-time

permissions

required

The set of permissions for the GitHub app

object

issues

string

checks

string

metadata

string

contents

string

deployments

string

key

additional properties

string

events

required

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

Array<string>

installations_count

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

integer

url

string

users_url

string

teams_url

string

bypass_pull_request_allowances

Allow specific users, teams, or apps to bypass pull request requirements.

object

users

The list of users allowed to bypass pull request requirements.

Array<object>

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

teams

The list of teams allowed to bypass pull request requirements.

Array<object>

Team

Groups of organization members that gives permissions on specified repositories.

object

required

integer

node_id

required

string

name

required

string

slug

required

string

description

required

string

nullable

privacy

string

notification_setting

string

permission

required

string

permissions

object

pull

required

boolean

triage

required

boolean

push

required

boolean

maintain

required

boolean

admin

required

boolean

url

required

string format: uri

html_url

required

string format: uri

members_url

required

string

repositories_url

required

string format: uri

type

required

The ownership type of the team

string

Allowed values: enterprise organization

access_source

How the team’s access to the repository was granted. This property is only present when the team is returned in a repository context, such as GET /repos/{owner}/{repo}/teams.

string

Allowed values: direct organization enterprise

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

parent

required

Team Simple

Groups of organization members that gives permissions on specified repositories.

object

required

Unique identifier of the team

integer

node_id

required

string

url

required

URL for the team

string format: uri

members_url

required

string

name

required

Name of the team

string

description

required

Description of the team

string

nullable

permission

required

Permission that the team will have for its repositories

string

privacy

The level of privacy this team should have

string

notification_setting

The notification setting the team has set

string

html_url

required

string format: uri

repositories_url

required

string format: uri

slug

required

string

ldap_dn

Distinguished Name (DN) that team maps to within LDAP environment

string

type

required

The ownership type of the team

string

Allowed values: enterprise organization

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

apps

The list of apps allowed to bypass pull request requirements.

Array<object>

GitHub app

object

required

Unique identifier of the GitHub app

integer

slug

The slug name of the GitHub app

string

node_id

required

string

client_id

string

owner

required

One of:

Simple User
Enterprise

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

name

required

The name of the GitHub app

string

description

required

string

nullable

external_url

required

string format: uri

html_url

required

string format: uri

created_at

required

string format: date-time

updated_at

required

string format: date-time

permissions

required

The set of permissions for the GitHub app

object

issues

string

checks

string

metadata

string

contents

string

deployments

string

key

additional properties

string

events

required

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

Array<string>

installations_count

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

integer

dismiss_stale_reviews

required

boolean

require_code_owner_reviews

required

boolean

required_approving_review_count

integer

<= 6

require_last_push_approval

Whether the most recent push must be approved by someone other than the person who pushed it.

boolean

restrictions

Branch Restriction Policy

Branch Restriction Policy

object

url

required

string format: uri

users_url

required

string format: uri

teams_url

required

string format: uri

apps_url

required

string format: uri

users

required

Array<object>

object

login

string

integer format: int64

node_id

string

avatar_url

string

gravatar_id

string

url

string

html_url

string

followers_url

string

following_url

string

gists_url

string

starred_url

string

subscriptions_url

string

organizations_url

string

repos_url

string

events_url

string

received_events_url

string

type

string

site_admin

boolean

user_view_type

string

teams

required

Array<object>

Team

Groups of organization members that gives permissions on specified repositories.

object

required

integer

node_id

required

string

name

required

string

slug

required

string

description

required

string

nullable

privacy

string

notification_setting

string

permission

required

string

permissions

object

pull

required

boolean

triage

required

boolean

push

required

boolean

maintain

required

boolean

admin

required

boolean

url

required

string format: uri

html_url

required

string format: uri

members_url

required

string

repositories_url

required

string format: uri

type

required

The ownership type of the team

string

Allowed values: enterprise organization

access_source

How the team’s access to the repository was granted. This property is only present when the team is returned in a repository context, such as GET /repos/{owner}/{repo}/teams.

string

Allowed values: direct organization enterprise

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

parent

required

Team Simple

Groups of organization members that gives permissions on specified repositories.

object

required

Unique identifier of the team

integer

node_id

required

string

url

required

URL for the team

string format: uri

members_url

required

string

name

required

Name of the team

string

description

required

Description of the team

string

nullable

permission

required

Permission that the team will have for its repositories

string

privacy

The level of privacy this team should have

string

notification_setting

The notification setting the team has set

string

html_url

required

string format: uri

repositories_url

required

string format: uri

slug

required

string

ldap_dn

Distinguished Name (DN) that team maps to within LDAP environment

string

type

required

The ownership type of the team

string

Allowed values: enterprise organization

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

apps

required

Array<object>

object

integer

slug

string

node_id

string

owner

object

login

string

integer

node_id

string

url

string

repos_url

string

events_url

string

hooks_url

string

issues_url

string

members_url

string

public_members_url

string

avatar_url

string

description

string

gravatar_id

string

html_url

string

followers_url

string

following_url

string

gists_url

string

starred_url

string

subscriptions_url

string

organizations_url

string

received_events_url

string

type

string

site_admin

boolean

user_view_type

string

name

string

client_id

string

description

string

external_url

string

html_url

string

created_at

string

updated_at

string

permissions

object

metadata

string

contents

string

issues

string

single_file

string

events

Array<string>

required_linear_history

object

enabled

boolean

allow_force_pushes

object

enabled

boolean

allow_deletions

object

enabled

boolean

block_creations

object

enabled

boolean

required_conversation_resolution

object

enabled

boolean

name

string

protection_url

string

required_signatures

object

url

required

string format: uri

enabled

required

boolean

lock_branch

Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.

object

enabled

boolean

allow_fork_syncing

Whether users can pull changes from upstream when the branch is locked. Set to true to allow fork syncing. Set to false to prevent fork syncing.

object

enabled

boolean

protection_url

required

string format: uri

pattern

string

required_approving_review_count

integer

Examples

default

{
  "name": "main",
  "commit": {
    "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
    "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk",
    "commit": {
      "author": {
        "name": "The Octocat",
        "email": "octocat@nowhere.com",
        "date": "2012-03-06T23:06:50Z"
      },
      "committer": {
        "name": "The Octocat",
        "email": "octocat@nowhere.com",
        "date": "2012-03-06T23:06:50Z"
      },
      "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
      "tree": {
        "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
        "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
      },
      "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
      "comment_count": 77,
      "verification": {
        "verified": false,
        "reason": "unsigned",
        "signature": null,
        "payload": null,
        "verified_at": null
      }
    },
    "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
    "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
    "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments",
    "author": {
      "login": "octocat",
      "id": 583231,
      "node_id": "MDQ6VXNlcjU4MzIzMQ==",
      "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "committer": {
      "login": "octocat",
      "id": 583231,
      "node_id": "MDQ6VXNlcjU4MzIzMQ==",
      "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "parents": [
      {
        "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
        "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
        "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
      },
      {
        "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
        "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303",
        "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303"
      }
    ]
  },
  "_links": {
    "self": "https://api.github.com/repos/octocat/Hello-World/branches/main",
    "html": "https://github.com/octocat/Hello-World/tree/main"
  },
  "protected": false,
  "protection": {
    "enabled": false,
    "required_status_checks": {
      "enforcement_level": "off",
      "contexts": [],
      "checks": []
    }
  },
  "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection"
}

301

Moved permanently

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

Get a branch

Parameters

Path Parameters

Responses

200

Examples

301

Example generated

404

Example generated

Example ^generated

Example ^generated