per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
List events received by the authenticated user
These are events that you’ve received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you’ll only see public events.
get
{protocol}://{hostname}/api/v3/users/{username}/received_events
Query Parameters
Path Parameters
usernamestringrequired
Response
200 application/json
Response
200 application/json
Response
Event
idstringrequired
typestring | nullrequired
actorobjectrequired
Actor
Show Child Parameters
repoobjectrequired
Show Child Parameters
orgobject
Actor
Show Child Parameters
payloadobjectrequired
Show Child Parameters
publicbooleanrequired
created_atstring | null(date-time)required
get/users/{username}/received_events
Path Parameters
Query Parameters
200 application/json
List public events received by a user
get
{protocol}://{hostname}/api/v3/users/{username}/received_events/public
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
usernamestringrequired
Response
200 application/json
Response
200 application/json
Response
Event
idstringrequired
typestring | nullrequired
actorobjectrequired
Actor
Show Child Parameters
repoobjectrequired
Show Child Parameters
orgobject
Actor
Show Child Parameters
payloadobjectrequired
Show Child Parameters
publicbooleanrequired
created_atstring | null(date-time)required
get/users/{username}/received_events/public
Path Parameters
Query Parameters
200 application/json
List repositories starred by a user
Lists repositories a 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/users/{username}/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
Path Parameters
usernamestringrequired
Response
200 application/json
Response
200 application/json
Response
Any Ofstarred_atstring(date-time)required
repoobjectrequired
A git repository
Show Child Parameters
get/users/{username}/starred
Path Parameters
Query Parameters
200 application/json
List repositories watched by a user
Lists repositories a user is watching.
get
{protocol}://{hostname}/api/v3/users/{username}/subscriptions
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
usernamestringrequired
Response
200 application/json
Response
200 application/json
Response
Minimal Repository
idintegerrequired
Example:1296269
node_idstringrequired
Example:MDEwOlJlcG9zaXRvcnkxMjk2MjY5
namestringrequired
Example:Hello-World
full_namestringrequired
Example:octocat/Hello-World
ownerobjectrequired
Simple User
Show Child Parameters
privatebooleanrequired
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_urlstring
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_urlstring
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_urlstring
mirror_urlstring | null
hooks_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/hooks
svn_urlstring
homepagestring | null
languagestring | null
forks_countinteger
stargazers_countinteger
watchers_countinteger
sizeinteger
default_branchstring
open_issues_countinteger
is_templateboolean
topicsarray[string]
has_issuesboolean
has_projectsboolean
has_wikiboolean
has_pagesboolean
has_downloadsboolean
archivedboolean
disabledboolean
visibilitystring
pushed_atstring | null(date-time)
Example:2011-01-26T19:06:43Z
created_atstring | null(date-time)
Example:2011-01-26T19:01:12Z
updated_atstring | null(date-time)
Example:2011-01-26T19:14:43Z
permissionsobject
Show Child Parameters
template_repositoryobject | null
A git repository
Show Child Parameters
temp_clone_tokenstring
delete_branch_on_mergeboolean
subscribers_countinteger
network_countinteger
code_of_conductobject
Code Of Conduct
Show Child Parameters
licenseobject | null
Show Child Parameters
forksinteger
Example:0
open_issuesinteger
Example:0
watchersinteger
Example:0
allow_forkingboolean
get/users/{username}/subscriptions
Path Parameters
Query Parameters
200 application/json
Get the authenticated app
Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app’s installations, see the “List installations for the authenticated app” endpoint.
You must use a JWT to access this endpoint.
get
{protocol}://{hostname}/api/v3/app
Response
200 application/json
Response
200 application/json
Response
GitHub app
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
idintegerrequired
Unique identifier of the GitHub app
Example:37
slugstring
The slug name of the GitHub app
Example:probot-owners
node_idstringrequired
Example:MDExOkludGVncmF0aW9uMQ==
ownerobject | nullrequired
Simple User
Show Child Parameters
namestringrequired
The name of the GitHub app
Example:Probot Owners
descriptionstring | nullrequired
Example:The description of the app.
external_urlstring(uri)required
Example:https://example.com
html_urlstring(uri)required
Example:https://github.com/apps/super-ci
created_atstring(date-time)required
Example:2017-07-08T16:18:44-04:00
updated_atstring(date-time)required
Example:2017-07-08T16:18:44-04:00
permissionsobjectrequired
The set of permissions for the GitHub app
Example:{"issues":"read","deployments":"write"}
Show Child Parameters
eventsarray[string]required
The list of events for the GitHub app
Example:["label","deployment"]
installations_countinteger
The number of installations associated with the GitHub app
Example:5
client_idstring
Example:"Iv1.25b5d1e65ffc4022"
client_secretstring
Example:"1d4b2097ac622ba702d19de498f005747a8b21d3"
webhook_secretstring | null
Example:"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"
pemstring
Example:"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"
get/app
200 application/json