GitHub v3 REST API

List stargazers

Lists the people that have starred the repository.

You can also find out when stars were created by passing the following custom media type via the Accept header:

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/stargazers

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

ownerstringrequired
repostringrequired

Response

application/json

Response

Any Of
namestring | null
emailstring | null
loginstringrequired

Example:octocat

idintegerrequired

Example:1

node_idstringrequired

Example:MDQ6VXNlcjE=

avatar_urlstring(uri)required

Example:https://github.com/images/error/octocat_happy.gif

gravatar_idstring | nullrequired

Example:41d064eb2195891e12d0413f63227ea7

urlstring(uri)required

Example:https://api.github.com/users/octocat

html_urlstring(uri)required

Example:https://github.com/octocat

followers_urlstring(uri)required

Example:https://api.github.com/users/octocat/followers

following_urlstringrequired

Example:https://api.github.com/users/octocat/following{/other_user}

gists_urlstringrequired

Example:https://api.github.com/users/octocat/gists{/gist_id}

starred_urlstringrequired

Example:https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_urlstring(uri)required

Example:https://api.github.com/users/octocat/subscriptions

organizations_urlstring(uri)required

Example:https://api.github.com/users/octocat/orgs

repos_urlstring(uri)required

Example:https://api.github.com/users/octocat/repos

events_urlstringrequired

Example:https://api.github.com/users/octocat/events{/privacy}

received_events_urlstring(uri)required

Example:https://api.github.com/users/octocat/received_events

typestringrequired

Example:User

site_adminbooleanrequired
starred_atstring

Example:"2020-07-09T00:17:55Z"

get/repos/{owner}/{repo}/stargazers
 
application/json

List watchers

Lists the people watching the specified repository.

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/subscribers

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

ownerstringrequired
repostringrequired

Response

200 application/json

Response

Simple User

namestring | null
emailstring | null
loginstringrequired

Example:octocat

idintegerrequired

Example:1

node_idstringrequired

Example:MDQ6VXNlcjE=

avatar_urlstring(uri)required

Example:https://github.com/images/error/octocat_happy.gif

gravatar_idstring | nullrequired

Example:41d064eb2195891e12d0413f63227ea7

urlstring(uri)required

Example:https://api.github.com/users/octocat

html_urlstring(uri)required

Example:https://github.com/octocat

followers_urlstring(uri)required

Example:https://api.github.com/users/octocat/followers

following_urlstringrequired

Example:https://api.github.com/users/octocat/following{/other_user}

gists_urlstringrequired

Example:https://api.github.com/users/octocat/gists{/gist_id}

starred_urlstringrequired

Example:https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_urlstring(uri)required

Example:https://api.github.com/users/octocat/subscriptions

organizations_urlstring(uri)required

Example:https://api.github.com/users/octocat/orgs

repos_urlstring(uri)required

Example:https://api.github.com/users/octocat/repos

events_urlstringrequired

Example:https://api.github.com/users/octocat/events{/privacy}

received_events_urlstring(uri)required

Example:https://api.github.com/users/octocat/received_events

typestringrequired

Example:User

site_adminbooleanrequired
starred_atstring

Example:"2020-07-09T00:17:55Z"

get/repos/{owner}/{repo}/subscribers
 
200 application/json

Get a repository subscription

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/subscription

Path Parameters

ownerstringrequired
repostringrequired

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
 
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
http://HOSTNAME/api/v3/repos/{owner}/{repo}/subscription

Path Parameters

ownerstringrequired
repostringrequired

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

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

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
http://HOSTNAME/api/v3/repos/{owner}/{repo}/subscription

Path Parameters

ownerstringrequired
repostringrequired

Response

204

Response

delete/repos/{owner}/{repo}/subscription
 
204