Sample - GitHub REST API
GET/repos/{owner}/{repo}/releases

List releases

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
per_pageintegeroptional
The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Default:30
pageintegeroptional
The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Default:1

2 status codes
200Response
urlstringrequired
html_urlstringrequired
assets_urlstringrequired
upload_urlstringrequired
tarball_urlstringrequired
zipball_urlstringrequired
idintegerrequired
node_idstringrequired
tag_namestringrequired
The name of the tag.
target_commitishstringrequired
Specifies the commitish value that determines where the Git tag is created from.
namestringrequired
bodystringoptional
draftbooleanrequired
true to create a draft (unpublished) release, false to create a published one.
prereleasebooleanrequired
Whether to identify the release as a prerelease or a full release.
immutablebooleanoptional
Whether or not the release is immutable.
created_atstringrequired
published_atstringrequired
updated_atstringoptional
authorobjectrequired
A GitHub user.
assetsarray<ReleaseAsset>required
body_htmlstringoptional
body_textstringoptional
mentions_countintegeroptional
discussion_urlstringoptional
The URL of the release discussion.
reactionsobjectoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.