• List your email addresses
• List email addresses for a user
• Get a single email address
• Add an email address
• Add an email address for a user
• Delete one of your email addresses
• Delete an email address for a user

User email addresses API

You can manage user email addresses by using the REST API.

List your email addresses

Get a list of your email addresses.

Prerequisites:

• You must be authenticated.

This endpoint does not return the primary email address, but issue 25077 proposes to change this behavior.

GET /user/emails

Example response:

[
  {
    "id": 1,
    "email": "email@example.com",
    "confirmed_at" : "2021-03-26T19:07:56.248Z"
  },
  {
    "id": 3,
    "email": "email2@example.com",
    "confirmed_at" : null
  }
]

List email addresses for a user

Get a list of a specified user’s emails.

Prerequisites:

• You must be an administrator.

This endpoint does not return the primary email address, but issue 25077 proposes to change this behavior.

GET /users/:id/emails

Supported attributes:

Get a single email address

Get a single email address.

GET /user/emails/:email_id

Supported attributes:

Example response:

{
  "id": 1,
  "email": "email@example.com",
  "confirmed_at" : "2021-03-26T19:07:56.248Z"
}

Add an email address

Creates a new email owned by the authenticated user.

POST /user/emails

Supported attributes:

{
  "id": 4,
  "email": "email@example.com",
  "confirmed_at" : "2021-03-26T19:07:56.248Z"
}

Returns a created email with status 201 Created on success. If an error occurs a 400 Bad Request is returned with a message explaining the error:

{
  "message": {
    "email": [
      "has already been taken"
    ]
  }
}

Add an email address for a user

Create a new email address owned by the specified user.

Prerequisites:

• You must be an administrator.

POST /users/:id/emails

Supported attributes:

Delete one of your email addresses

Delete one of your email addresses, other than your primary email address.

Prerequisites:

• You must be authenticated.

If the deleted email address is used for any user emails, those user emails are sent to the primary email address instead.

Because of known issue, group notifications are still sent to the deleted email address.

DELETE /user/emails/:email_id

Supported attributes:

Returns:

• 204 No Content if the operation was successful.
• 404 if the resource was not found.

Delete an email address for a user

Delete an email address for a user.

Prerequisites:

• You must be an administrator.

Deletes an email address of a specified user. You cannot delete a primary email address.

DELETE /users/:id/emails/:email_id

Supported attributes: