Skip to main content

users

Overview

Nameusers
TypeResource
Idgithub.users.users

Fields

NameDatatype
idinteger
namestring
collaboratorsinteger
public-user_emailstring
private_gistsinteger
events_urlstring
public-user_organizations_urlstring
public_reposinteger
gists_urlstring
locationstring
public-user_public_reposinteger
total_private_reposinteger
html_urlstring
organizations_urlstring
emailstring
planobject
public-user_received_events_urlstring
followers_urlstring
gravatar_idstring
typestring
public-user_collaboratorsinteger
owned_private_reposinteger
disk_usageinteger
received_events_urlstring
public-user_suspended_atstring
biostring
public-user_private_gistsinteger
updated_atstring
public-user_created_atstring
public-user_starred_urlstring
public-user_node_idstring
public-user_total_private_reposinteger
public-user_companystring
public-user_subscriptions_urlstring
public-user_namestring
loginstring
public-user_public_gistsinteger
site_adminboolean
public-user_idinteger
repos_urlstring
public-user_gravatar_idstring
twitter_usernamestring
public-user_followersinteger
public-user_events_urlstring
public-user_typestring
avatar_urlstring
companystring
public-user_biostring
public-user_blogstring
subscriptions_urlstring
public_gistsinteger
public-user_locationstring
public-user_owned_private_reposinteger
node_idstring
public-user_disk_usageinteger
public-user_urlstring
ldap_dnstring
followersinteger
public-user_followers_urlstring
public-user_loginstring
public-user_repos_urlstring
public-user_followinginteger
public-user_gists_urlstring
urlstring
two_factor_authenticationboolean
public-user_site_adminboolean
created_atstring
public-user_planobject
starred_urlstring
following_urlstring
public-user_hireableboolean
public-user_html_urlstring
public-user_following_urlstring
hireableboolean
business_plusboolean
public-user_updated_atstring
public-user_twitter_usernamestring
suspended_atstring
followinginteger
public-user_avatar_urlstring
blogstring

Methods

NameAccessible byRequired ParamsDescription
get_authenticatedSELECTIf the authenticated user is authenticated with an OAuth token with the user scope, then the response lists public and private profile information.

If the authenticated user is authenticated through OAuth without the user scope, then the response lists only public profile information.
get_by_usernameSELECTusernameProvides 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 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 plan information' below"

The email key in the following response is the publicly visible email address from your GitHub 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. 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".
update_authenticatedEXECNote: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.