GitHub v3 REST API

Get contextual information for a user

Provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

The subject_type and subject_id parameters provide context for the person’s hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about octocat who owns the Spoon-Knife repository via cURL, it would look like this:

 curl -u username:token
  https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192
get
/users/{username}/hovercard

Query Parameters

subject_typestring

Identifies which additional information you’d like to receive about the person’s hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

Allowed values:organizationrepositoryissuepull_request

subject_idstring

Uses the ID for the subject_type you specified. Required when using subject_type.

Path Parameters

usernamestringrequired

Response

application/json

Response

Hovercard

Hovercard

contextsarray[object]required
Show Child Parameters
get/users/{username}/hovercard
application/json

List public keys for a user

Lists the verified public SSH keys for a user. This is accessible by anyone.

get
/users/{username}/keys

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

Key Simple

idintegerrequired
keystringrequired
get/users/{username}/keys
200 application/json

global-hook

object
typestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
Example

global-hook-2

object
typestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
Example

public-key-full

object
idintegerrequired
keystringrequired
user_idintegerrequired
repository_idintegerrequired
urlstringrequired
titlestringrequired
read_onlybooleanrequired
verifiedbooleanrequired
created_atstring(date-time)required
last_usedstring(date-time)required
Example