Skip to content
forgit api docs

Gets the tag object of an annotated tag (not lightweight tags)

GET
/repos/{owner}/{repo}/git/tags/{sha}

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

sha
required
string

Sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

AnnotatedTag

Media type application/json

AnnotatedTag represents an annotated tag

object
archive_download_count

TagArchiveDownloadCount counts how many times a archive was downloaded

object
tar_gz
integer format: int64
zip
integer format: int64
message
string
object

AnnotatedTagObject contains meta information of the tag object

object
sha
string
type
string
url
string
sha
string
tag
string
tagger
CommitUser contains information of a user in the context of a commit.
object
date
string
email
string format: email
name
string
url
string
verification

PayloadCommitVerification represents the GPG verification of a commit

object
payload
string
reason
string
signature
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
string
verified
boolean
Example generated 
{
  "archive_download_count": {
    "tar_gz": 1,
    "zip": 1
  },
  "message": "example",
  "object": {
    "sha": "example",
    "type": "example",
    "url": "example"
  },
  "sha": "example",
  "tag": "example",
  "tagger": {
    "date": "example",
    "email": "hello@example.com",
    "name": "example"
  },
  "url": "example",
  "verification": {
    "payload": "example",
    "reason": "example",
    "signature": "example",
    "signer": {
      "email": "hello@example.com",
      "name": "example",
      "username": "example"
    },
    "verified": true
  }
}

400

Section titled “ 400 ”

APIError is error format response

Media type application/json

APIError is an api error with a message

object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}

404

Section titled “ 404 ”

APINotFound is a not found error response

Media type application/json
object
errors
Array<string>
message
string
url
string
Example generated 
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}