REST API endpoints for emails

About email administration

If a request URL does not include a {username} parameter then the response will be for the signed-in user (and you must pass authentication information with your request). Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through OAuth with the user scope.

Set primary email visibility for the authenticated user

Sets the visibility for your primary email addresses.

Fine-grained access tokens for "Set primary email visibility for the authenticated user"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Email addresses" user permissions (write)

Parameters for "Set primary email visibility for the authenticated user"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Body parameters
Name, Type, Description
`visibility` string Required Denotes whether an email is publicly visible. Can be one of: `public`, `private`

HTTP response status codes for "Set primary email visibility for the authenticated user"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Set primary email visibility for the authenticated user"

Request example

patch/user/email/visibility

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/email/visibility \
  -d '{"visibility":"private"}'

Response

Status: 200

[
  {
    "email": "[email protected]",
    "primary": true,
    "verified": true,
    "visibility": "private"
  }
]

List email addresses for the authenticated user

Lists all of your email addresses, and specifies which one is visible to the public.

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

Fine-grained access tokens for "List email addresses for the authenticated user"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Email addresses" user permissions (read)

Parameters for "List email addresses for the authenticated user"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Query parameters
Name, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1`

HTTP response status codes for "List email addresses for the authenticated user"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Code samples for "List email addresses for the authenticated user"

Request example

get/user/emails

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/emails

Response

Status: 200

[
  {
    "email": "[email protected]",
    "verified": true,
    "primary": true,
    "visibility": "public"
  }
]

Add an email address for the authenticated user

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

Fine-grained access tokens for "Add an email address for the authenticated user"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Email addresses" user permissions (write)

Parameters for "Add an email address for the authenticated user"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Body parameters
Name, Type, Description
`emails` array of strings 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.

HTTP response status codes for "Add an email address for the authenticated user"

Status code	Description
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Add an email address for the authenticated user"

Request example

post/user/emails

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/emails \
  -d '{"emails":["[email protected]","[email protected]","[email protected]"]}'

Response

Status: 201

[
  {
    "email": "[email protected]",
    "primary": false,
    "verified": false,
    "visibility": "public"
  },
  {
    "email": "[email protected]",
    "primary": false,
    "verified": false,
    "visibility": null
  },
  {
    "email": "[email protected]",
    "primary": false,
    "verified": false,
    "visibility": null
  }
]

Delete an email address for the authenticated user

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

Fine-grained access tokens for "Delete an email address for the authenticated user"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Email addresses" user permissions (write)

Parameters for "Delete an email address for the authenticated user"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Body parameters
Name, Type, Description
`emails` array of strings Required Email addresses associated with the GitHub user account.

HTTP response status codes for "Delete an email address for the authenticated user"

Status code	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples for "Delete an email address for the authenticated user"

Request example

delete/user/emails

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/emails \
  -d '{"emails":["[email protected]","[email protected]"]}'

Response

Status: 204

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.

Fine-grained access tokens for "List public email addresses for the authenticated user"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Email addresses" user permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "List public email addresses for the authenticated user"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Query parameters
Name, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1`

HTTP response status codes for "List public email addresses for the authenticated user"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Code samples for "List public email addresses for the authenticated user"

Request example

get/user/public_emails

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/user/public_emails

Response

Status: 200

[
  {
    "email": "[email protected]",
    "verified": true,
    "primary": true,
    "visibility": "public"
  }
]