GitHub v3 REST API

Private User

object

Private User

loginstringrequired

Example:octocat

idintegerrequired

Example:1

node_idstringrequired

Example:MDQ6VXNlcjE=

avatar_urlstring(uri)required

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

gravatar_idstringrequired

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
namestringrequired

Example:monalisa octocat

companystringrequired

Example:GitHub

blogstringrequired

Example:https://github.com/blog

locationstringrequired

Example:San Francisco

emailstring(email)required

Example:octocat@github.com

hireablebooleanrequired
biostringrequired

Example:There once was...

public_reposintegerrequired

Example:2

public_gistsintegerrequired

Example:1

followersintegerrequired

Example:20

followingintegerrequired
created_atstring(date-time)required

Example:2008-01-14T04:33:35Z

updated_atstring(date-time)required

Example:2008-01-14T04:33:35Z

private_gistsintegerrequired

Example:81

total_private_reposintegerrequired

Example:100

owned_private_reposintegerrequired

Example:100

disk_usageintegerrequired

Example:10000

collaboratorsintegerrequired

Example:8

two_factor_authenticationbooleanrequired

Example:true

planobject
Show Child Parameters
suspended_atstring(date-time)
business_plusboolean
ldap_dnstring
Example

Email

object

Email

emailstring(email)required

Example:octocat@github.com

primarybooleanrequired

Example:true

verifiedbooleanrequired

Example:true

visibilitystringrequired

Example:public

Example

GPG Key

object

A unique encryption key

idintegerrequired

Example:3

primary_key_idintegerrequired
key_idstringrequired

Example:3262EFF25BA0D270

public_keystringrequired

Example:xsBNBFayYZ...

emailsarray[object]required

Example:{"email":"mastahyeti@users.noreply.github.com","verified":true}

Show Child Parameters
subkeysarray[object]required

Example:{"id":4,"primary_key_id":3,"key_id":"4A595D4C72EE49C7","public_key":"zsBNBFayYZ...","emails":[],"subkeys":[],"can_sign":false,"can_encrypt_comms":true,"can_encrypt_storage":true,"can_certify":false,"created_at":"2016-03-24T11:31:04-06:00","expires_at":null}

Show Child Parameters
can_signbooleanrequired

Example:true

can_encrypt_commsbooleanrequired
can_encrypt_storagebooleanrequired
can_certifybooleanrequired

Example:true

created_atstring(date-time)required

Example:2016-03-24T11:31:04-06:00

expires_atstring(date-time)required
raw_keystringrequired
Example

Key

object

Key

keystringrequired
idintegerrequired
urlstringrequired
titlestringrequired
created_atstring(date-time)required
verifiedbooleanrequired
read_onlybooleanrequired
Example

Starred Repository

object

Starred Repository

starred_atstring(date-time)required
repoobjectrequired

A git repository

Show Child Parameters
Example