Get specified ref or filtered repository's refs

GET

/repos/{owner}/{repo}/git/refs/{ref}

curl --request GET \
  --url https://gitea.com/api/v1/repos/example/example/git/refs/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

ref

required

string

Part or full name of the ref

Responses

200

ReferenceList

Media typeapplication/json

Array<object>

Reference represents a Git reference.

object

object

GitObject represents a Git object.

object

sha

The SHA hash of the Git object

string

type

The type of the Git object (e.g., commit, tag, tree, blob)

string

url

The URL to access this Git object

string format: uri

ref

The name of the Git reference (e.g., refs/heads/main)

string

url

The URL to access this Git reference

string format: uri

Example^generated

[
  {
    "object": {
      "sha": "example",
      "type": "example",
      "url": "https://example.com"
    },
    "ref": "example",
    "url": "https://example.com"
  }
]

404

APINotFound is a not found empty response