GitHub v3 REST API

Event

object

Event

idstringrequired
typestringrequired
actorobjectrequired

Actor

Show Child Parameters
repoobjectrequired
Show Child Parameters
orgobject

Actor

Show Child Parameters
payloadobjectrequired
Show Child Parameters
publicbooleanrequired
created_atstring(date-time)required
Example

Link With Type

object

Hypermedia Link with Type

hrefstringrequired
typestringrequired
Example

Feed

object

Feed

timeline_urlstringrequired

Example:https://github.com/timeline

user_urlstringrequired

Example:https://github.com/{user}

current_user_public_urlstring

Example:https://github.com/octocat

current_user_urlstring

Example:https://github.com/octocat.private?token=abc123

current_user_actor_urlstring

Example:https://github.com/octocat.private.actor?token=abc123

current_user_organization_urlstring

Example:https://github.com/octocat-org

current_user_organization_urlsarray[string](uri)

Example:https://github.com/organizations/github/octocat.private.atom?token=abc123

_linksobjectrequired
Show Child Parameters
Example

Base Gist

object

Base Gist

urlstring(uri)required
forks_urlstring(uri)required
commits_urlstring(uri)required
idstringrequired
node_idstringrequired
git_pull_urlstring(uri)required
git_push_urlstring(uri)required
html_urlstring(uri)required
filesobjectrequired
publicbooleanrequired
created_atstring(date-time)required
updated_atstring(date-time)required
descriptionstringrequired
commentsintegerrequired
userobjectrequired

Simple User

Show Child Parameters
comments_urlstring(uri)required
ownerobject

Simple User

Show Child Parameters
truncatedboolean
forksarray
historyarray
Example

Public User

object

Public User

* Additional properties are NOT allowed.
loginstringrequired
idintegerrequired
node_idstringrequired
avatar_urlstring(uri)required
gravatar_idstringrequired
urlstring(uri)required
html_urlstring(uri)required
followers_urlstring(uri)required
following_urlstringrequired
gists_urlstringrequired
starred_urlstringrequired
subscriptions_urlstring(uri)required
organizations_urlstring(uri)required
repos_urlstring(uri)required
events_urlstringrequired
received_events_urlstring(uri)required
typestringrequired
site_adminbooleanrequired
namestringrequired
companystringrequired
blogstringrequired
locationstringrequired
emailstring(email)required
hireablebooleanrequired
biostringrequired
public_reposintegerrequired
public_gistsintegerrequired
followersintegerrequired
followingintegerrequired
created_atstring(date-time)required
updated_atstring(date-time)required
planobject
Show Child Parameters
suspended_atstring(date-time)
private_gistsinteger

Example:1

total_private_reposinteger

Example:2

owned_private_reposinteger

Example:2

disk_usageinteger

Example:1

collaboratorsinteger

Example:3

Example