Search
K
GitHub v3 REST API

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

Gist History

object

Gist History

userobject

Simple User

Show Child Parameters
versionstring
committed_atstring(date-time)
change_statusobject
Show Child Parameters
urlstring(uri)
Example

Gist Simple

object

Gist Simple

forksarray[object]DEPRECATED
Show Child Parameters
historyarray[object]DEPRECATED

Gist History

Show Child Parameters
fork_ofobject

Gist

Show Child Parameters
urlstring
forks_urlstring
commits_urlstring
idstring
node_idstring
git_pull_urlstring
git_push_urlstring
html_urlstring
filesobject
publicboolean
created_atstring
updated_atstring
descriptionstring
commentsinteger
userstring
comments_urlstring
ownerobject

Simple User

Show Child Parameters
truncatedboolean
Example

Gist Comment

object

A comment made to a gist.

idintegerrequired

Example:1

node_idstringrequired

Example:MDExOkdpc3RDb21tZW50MQ==

urlstring(uri)required

Example:https://api.github.com/gists/a6db0bec360bb87e9418/comments/1

bodystringrequired

The comment text.

<= 65535 characters

Example:Body of the attachment

userobjectrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-18T23:23:56Z

updated_atstring(date-time)required

Example:2011-04-18T23:23:56Z

author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

Example

Gist Commit

object

Gist Commit

urlstring(uri)required

Example:https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f

versionstringrequired

Example:57a7f021a713b1c5a6a199b54cc514735d2d462f

userobjectrequired

Simple User

Show Child Parameters
change_statusobjectrequired
Show Child Parameters
committed_atstring(date-time)required

Example:2010-04-14T02:15:15Z

Example