per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
List email addresses for the authenticated user
Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.
get
http://HOSTNAME/api/v3/user/emails
Query Parameters
Response
application/json
Response
application/json
Response
emailstring(email)required
Example:octocat@github.com
primarybooleanrequired
Example:true
verifiedbooleanrequired
Example:true
visibilitystring | nullrequired
Example:public
get/user/emails
Query Parameters
application/json
Add an email address for the authenticated user
This endpoint is accessible with the user scope.
post
http://HOSTNAME/api/v3/user/emails
Body
application/json
Body
application/json
One Ofemailsarray[string]required
Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.
>= 1 items
Example:username@example.com
Response
application/json
Response
application/json
Response
emailstring(email)required
Example:octocat@github.com
primarybooleanrequired
Example:true
verifiedbooleanrequired
Example:true
visibilitystring | nullrequired
Example:public
post/user/emails
Body
{}
application/json
Delete an email address for the authenticated user
This endpoint is accessible with the user scope.
delete
http://HOSTNAME/api/v3/user/emails
Body
application/json
Body
application/json
One Ofemailsarray[string]required
Email addresses associated with the GitHub user account.
>= 1 items
Example:username@example.com
Response
Response
Response
delete/user/emails
Body
{}
List followers of the authenticated user
Lists the people following the authenticated user.
get
http://HOSTNAME/api/v3/user/followers
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Response
application/json
Response
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/user/followers
Query Parameters
application/json
List the people the authenticated user follows
Lists the people who the authenticated user follows.
get
http://HOSTNAME/api/v3/user/following
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Response
application/json
Response
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/user/following
Query Parameters
application/json