Skip to content
forgit api docs

List a repo's releases

GET
/repos/{owner}/{repo}/releases

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

Query Parameters

Section titled “ Query Parameters ”
draft
boolean

Filter (exclude / include) drafts, if you dont have repo write access none will show

pre-release
boolean

Filter (exclude / include) pre-releases

q
string

Search string

page
integer

Page number of results to return (1-based)

limit
integer

Page size of results

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

ReleaseList

Media type application/json
Array<object>

Release represents a repository release

object
archive_download_count

TagArchiveDownloadCount counts how many times a archive was downloaded

object
tar_gz
integer format: int64
zip
integer format: int64
assets
Array<object>

Attachment a generic attachment

object
browser_download_url
string
created_at
string format: date-time
download_count
integer format: int64
id
integer format: int64
name
string
size
integer format: int64
type
string
Allowed values: attachment external
uuid
string
author

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
body
string
created_at
string format: date-time
draft
boolean
hide_archive_links
boolean
html_url
string
id
integer format: int64
name
string
prerelease
boolean
published_at
string format: date-time
tag_name
string
tarball_url
string
target_commitish
string
upload_url
string
url
string
zipball_url
string
Example 
[
  {
    "assets": [
      {
        "type": "attachment"
      }
    ],
    "author": {
      "login_name": "empty"
    }
  }
]

Headers

Section titled “ Headers ”
X-Total-Count
integer format: int64

The total number of releases

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"
}