users

List public email addresses for the authenticated user

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint.

OAuth app tokens and personal access tokens (classic) need the user:email scope to use this endpoint.

get/user/public_emails

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/user/public_emails
  • Auth: none declared

Query parameters

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Response

Response

emailstring email required
primaryboolean required
verifiedboolean required
visibilitystring nullable required

Example response

[
  {
    "email": "octocat@github.com",
    "primary": true,
    "verified": true,
    "visibility": "public"
  }
]

Changes

No recorded changes to this operation across all 83 revisions of this API.