List public email addresses for the authenticated user

GET

/user/public_emails

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.

API method documentation

Parameters

Query Parameters

per_page

integer

default: 30

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

page

integer

default: 1

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

Responses

200

Response

Media typeapplication/json

Array<object>

Email

Email

object

email

required

string format: email

primary

required

boolean

verified

required

boolean

visibility

required

string

nullable

Examples

Exampledefault

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

Headers

Link

string

Example

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

304

Not modified

401

Requires authentication

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media typeapplication/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}