Available user attributes

GitHub supports a multitude of attributes. The most important ones are described below.

For additional attributes, see an example payload in JSON Pointer syntax reference.

Attribute Description

Attribute	Description
access_token	The access token that GitHub provides to your application.
email	The user’s public email address, as shown their GitHub profile page.
emails	The complete list of email addresses associated with the user, including primary, public, and other addresses. This data is retrieved from the email endpoint and requires the `email` scope. The result is a JSON array that is stored as a string.
id	The unique ID for the user. This ID is only used in the context of your application.
name	The user’s name, as shown on the user’s GitHub profile page.
primary_email	The user’s email address that is marked as primary. This value is only available with the `email` scope.
username	The user’s GitHub username.

access_token

The access token that GitHub provides to your application.

The user’s public email address, as shown their GitHub profile page.

emails

The complete list of email addresses associated with the user, including primary, public, and other addresses. This data is retrieved from the email endpoint and requires the email scope. The result is a JSON array that is stored as a string.

The unique ID for the user. This ID is only used in the context of your application.

name

The user’s name, as shown on the user’s GitHub profile page.

primary_email

The user’s email address that is marked as primary. This value is only available with the email scope.

username

The user’s GitHub username.