usernamestringrequired
target_userstringrequired
Check if a user follows another user
get
{protocol}://{hostname}/api/v3/users/{username}/following/{target_user}
Path Parameters
Response
Response
if the user follows the target user
get/users/{username}/following/{target_user}
Path Parameters
List GPG keys for a user
Lists the GPG keys for a user. This information is accessible by anyone.
get
{protocol}://{hostname}/api/v3/users/{username}/gpg_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
200 application/json
Response
A unique encryption key
idintegerrequired
Example:3
primary_key_idinteger | nullrequired
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 | null(date-time)required
raw_keystring | nullrequired
get/users/{username}/gpg_keys
Path Parameters
Query Parameters
200 application/json
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
{protocol}://{hostname}/api/v3/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
application/json
Response
Hovercard
Hovercard
contextsarray[object]required
Show Child Parameters
get/users/{username}/hovercard
Path Parameters
Query Parameters
application/json
List public keys for a user
Lists the verified public SSH keys for a user. This is accessible by anyone.
get
{protocol}://{hostname}/api/v3/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
200 application/json
Response
Key Simple
idintegerrequired
keystringrequired
get/users/{username}/keys
Path Parameters
Query Parameters
200 application/json
global-hook
objecttypestring
idinteger
namestring
activeboolean
eventsarray[string]
configobject
Show Child Parameters
updated_atstring
created_atstring
urlstring
ping_urlstring
Example