ownerstringrequired
repostringrequired
Get a repository subscription
get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/subscription
Path Parameters
Response
application/json
Response
application/json
if you subscribe to the repository
Repository Invitation
Repository invitations let you manage who you collaborate with.
subscribedbooleanrequired
Determines if notifications should be received from this repository.
Example:true
ignoredbooleanrequired
Determines if all notifications should be blocked from this repository.
reasonstring | nullrequired
created_atstring(date-time)required
Example:2012-10-06T21:34:12Z
urlstring(uri)required
Example:https://api.github.com/repos/octocat/example/subscription
repository_urlstring(uri)required
Example:https://api.github.com/repos/octocat/example
get/repos/{owner}/{repo}/subscription
Path Parameters
application/json
Set a repository subscription
If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository’s subscription completely.
put
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/subscription
Path Parameters
ownerstringrequired
repostringrequired
Body
application/json
Body
application/json
subscribedboolean
Determines if notifications should be received from this repository.
ignoredboolean
Determines if all notifications should be blocked from this repository.
Response
200 application/json
Response
200 application/json
Response
Repository Invitation
Repository invitations let you manage who you collaborate with.
subscribedbooleanrequired
Determines if notifications should be received from this repository.
Example:true
ignoredbooleanrequired
Determines if all notifications should be blocked from this repository.
reasonstring | nullrequired
created_atstring(date-time)required
Example:2012-10-06T21:34:12Z
urlstring(uri)required
Example:https://api.github.com/repos/octocat/example/subscription
repository_urlstring(uri)required
Example:https://api.github.com/repos/octocat/example
put/repos/{owner}/{repo}/subscription
Path Parameters
Body
{}
200 application/json
Delete a repository subscription
This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository’s subscription manually.
delete
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/subscription
Path Parameters
ownerstringrequired
repostringrequired
Response
204
Response
204
Response
delete/repos/{owner}/{repo}/subscription
Path Parameters
204
List repositories starred by the authenticated user
Lists repositories the authenticated user has starred.
You can also find out when stars were created by passing the following custom media type via the Accept header:
get
{protocol}://{hostname}/api/v3/user/starred
Query Parameters
sortstring
One of created (when the repository was starred) or updated (when it was last pushed to).
Allowed values:createdupdated
Default:created
directionstring
One of asc (ascending) or desc (descending).
Allowed values:ascdesc
Default:desc
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Response
Response
Response
A git repository
idintegerrequired
Unique identifier of the repository
Example:42
node_idstringrequired
Example:MDEwOlJlcG9zaXRvcnkxMjk2MjY5
namestringrequired
The name of the repository.
Example:Team Environment
full_namestringrequired
Example:octocat/Hello-World
licenseobject | nullrequired
License Simple
Show Child Parameters
organizationobject | null
Simple User
Show Child Parameters
forksintegerrequired
permissionsobject
Show Child Parameters
ownerobjectrequired
Simple User
Show Child Parameters
privatebooleanrequired
Whether the repository is private or public.
Default:false
html_urlstring(uri)required
Example:https://github.com/octocat/Hello-World
descriptionstring | nullrequired
Example:This your first repo!
forkbooleanrequired
urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World
archive_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/contributors
deployments_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/deployments
downloads_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/downloads
events_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/events
forks_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/forks
git_commits_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_urlstringrequired
Example:git:github.com/octocat/Hello-World.git
issue_comment_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/languages
merges_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/merges
milestones_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_urlstringrequired
Example:git@github.com:octocat/Hello-World.git
stargazers_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/subscription
tags_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/tags
teams_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/teams
trees_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_urlstringrequired
Example:https://github.com/octocat/Hello-World.git
mirror_urlstring | null(uri)required
Example:git:git.example.com/octocat/Hello-World
hooks_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/hooks
svn_urlstring(uri)required
Example:https://svn.github.com/octocat/Hello-World
homepagestring | null(uri)required
Example:https://github.com
languagestring | nullrequired
forks_countintegerrequired
Example:9
stargazers_countintegerrequired
Example:80
watchers_countintegerrequired
Example:80
sizeintegerrequired
Example:108
default_branchstringrequired
The default branch of the repository.
Example:master
open_issues_countintegerrequired
Example:0
is_templateboolean
Whether this repository acts as a template that can be used to generate new repositories.
Default:false
Example:true
topicsarray[string]
has_issuesbooleanrequired
Whether issues are enabled.
Default:true
Example:true
has_projectsbooleanrequired
Whether projects are enabled.
Default:true
Example:true
has_wikibooleanrequired
Whether the wiki is enabled.
Default:true
Example:true
has_pagesbooleanrequired
has_downloadsbooleanrequired
Whether downloads are enabled.
Default:true
Example:true
archivedbooleanrequired
Whether the repository is archived.
Default:false
disabledbooleanrequired
Returns whether or not this repository disabled.
visibilitystring
The repository visibility: public, private, or internal.
Default:public
pushed_atstring | null(date-time)required
Example:2011-01-26T19:06:43Z
created_atstring | null(date-time)required
Example:2011-01-26T19:01:12Z
updated_atstring | null(date-time)required
Example:2011-01-26T19:14:43Z
allow_rebase_mergeboolean
Whether to allow rebase merges for pull requests.
Default:true
Example:true
template_repositoryobject | null
Show Child Parameters
temp_clone_tokenstring
allow_squash_mergeboolean
Whether to allow squash merges for pull requests.
Default:true
Example:true
delete_branch_on_mergeboolean
Whether to delete head branches when pull requests are merged
Default:false
Example:false
allow_merge_commitboolean
Whether to allow merge commits for pull requests.
Default:true
Example:true
allow_forkingboolean
Whether to allow forking this repo
subscribers_countinteger
network_countinteger
open_issuesintegerrequired
watchersintegerrequired
master_branchstring
starred_atstring
Example:"2020-07-09T00:17:42Z"
get/user/starred
Query Parameters
Check if a repository is starred by the authenticated user
get
{protocol}://{hostname}/api/v3/user/starred/{owner}/{repo}
Path Parameters
ownerstringrequired
repostringrequired
Response
Response
Response if this repository is starred by you
get/user/starred/{owner}/{repo}