Retrieve a specific branch from a repository, including its effective branch protection

GET

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

curl --request GET \
  --url https://gitea.example.com/api/v1/repos/example/example/branches/example \
  --header 'Authorization: Basic <credentials>'

Authorizations

• BasicAuth
• Token
• AccessToken
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

branch

required

string

Branch to get

Responses

200

Branch

Media typeapplication/json

Branch represents a repository branch

object

commit

PayloadCommit represents a commit

object

added

List of files added in this commit

Array<string>

author

PayloadUser represents the author or committer of a commit

object

email

string format: email

name

Full name of the commit author

string

username

Username of the user

string

committer

PayloadUser represents the author or committer of a commit

object

email

string format: email

name

Full name of the commit author

string

username

Username of the user

string

id

Sha1 hash of the commit

string

message

The commit message

string

modified

List of files modified in this commit

Array<string>

removed

List of files removed in this commit

Array<string>

timestamp

string format: date-time

url

The URL to view this commit

string

verification

PayloadCommitVerification represents the GPG verification of a commit

object

payload

The signed payload content

string

reason

The reason for the verification status

string

signature

The GPG signature of the commit

string

signer

PayloadUser represents the author or committer of a commit

object

email

string format: email

name

Full name of the commit author

string

username

Username of the user

string

verified

Whether the commit signature is verified

boolean

effective_branch_protection_name

EffectiveBranchProtectionName is the name of the effective branch protection rule

string

enable_status_check

EnableStatusCheck indicates if status checks are enabled

boolean

name

Name is the branch name

string

protected

Protected indicates if the branch is protected

boolean

required_approvals

RequiredApprovals is the number of required approvals for pull requests

integer format: int64

status_check_contexts

StatusCheckContexts contains the list of required status check contexts

Array<string>

user_can_merge

UserCanMerge indicates if the current user can merge to this branch

boolean

user_can_push

UserCanPush indicates if the current user can push to this branch

boolean

Example^generated

{
  "commit": {
    "added": [
      "example"
    ],
    "author": {
      "email": "hello@example.com",
      "name": "example",
      "username": "example"
    },
    "committer": {
      "email": "hello@example.com",
      "name": "example",
      "username": "example"
    },
    "id": "example",
    "message": "example",
    "modified": [
      "example"
    ],
    "removed": [
      "example"
    ],
    "timestamp": "2026-04-15T12:00:00Z",
    "url": "example",
    "verification": {
      "payload": "example",
      "reason": "example",
      "signature": "example",
      "signer": {
        "email": "hello@example.com",
        "name": "example",
        "username": "example"
      },
      "verified": true
    }
  },
  "effective_branch_protection_name": "example",
  "enable_status_check": true,
  "name": "example",
  "protected": true,
  "required_approvals": 1,
  "status_check_contexts": [
    "example"
  ],
  "user_can_merge": true,
  "user_can_push": true
}

404

APINotFound is a not found empty response

Media typeapplication/json