usernamestringrequired
Get a user
Provides publicly available information about someone with a GitHub account.
GitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user’s GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See “Identifying and authorizing users for GitHub Apps” for details about authentication. For an example response, see ‘Response with GitHub Enterprise Server plan information’ below"
The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.
The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see “Emails API”.
get
{protocol}://{hostname}/api/v3/users/{username}
Path Parameters
Response
application/json
Response
application/json
Response
One Ofloginstringrequired
Example:octocat
idintegerrequired
Example:1
node_idstringrequired
Example:MDQ6VXNlcjE=
avatar_urlstring(uri)required
Example:https://github.com/images/error/octocat_happy.gif
gravatar_idstring | nullrequired
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
namestring | nullrequired
Example:monalisa octocat
companystring | nullrequired
Example:GitHub
blogstring | nullrequired
Example:https://github.com/blog
locationstring | nullrequired
Example:San Francisco
emailstring | null(email)required
Example:octocat@github.com
hireableboolean | nullrequired
biostring | nullrequired
Example:There once was...
public_reposintegerrequired
Example:2
public_gistsintegerrequired
Example:1
followersintegerrequired
Example:20
followingintegerrequired
Example:0
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 | null(date-time)
business_plusboolean
ldap_dnstring
get/users/{username}
Path Parameters
application/json
List followers of a user
Lists the people following the specified user.
get
{protocol}://{hostname}/api/v3/users/{username}/followers
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
Simple User
namestring | null
emailstring | null
loginstringrequired
Example:octocat
idintegerrequired
Example:1
node_idstringrequired
Example:MDQ6VXNlcjE=
avatar_urlstring(uri)required
Example:https://github.com/images/error/octocat_happy.gif
gravatar_idstring | nullrequired
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
starred_atstring
Example:"2020-07-09T00:17:55Z"
get/users/{username}/followers
Path Parameters
Query Parameters
200 application/json
List the people a user follows
Lists the people who the specified user follows.
get
{protocol}://{hostname}/api/v3/users/{username}/following
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
Simple User
namestring | null
emailstring | null
loginstringrequired
Example:octocat
idintegerrequired
Example:1
node_idstringrequired
Example:MDQ6VXNlcjE=
avatar_urlstring(uri)required
Example:https://github.com/images/error/octocat_happy.gif
gravatar_idstring | nullrequired
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
starred_atstring
Example:"2020-07-09T00:17:55Z"
get/users/{username}/following
Path Parameters
Query Parameters
200 application/json
Check if a user follows another user
get
{protocol}://{hostname}/api/v3/users/{username}/following/{target_user}
Path Parameters
usernamestringrequired
target_userstringrequired
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