Email aliases resources

Email aliases provide a list of emails additional to the user’s primary login email.

Email alias

An email alias for a user.

Attributes and example

Property	Type	Required	Description
`id`	`string`	No	The unique identifier for this object.
`type`	`enum<string>`	No	The value will always be `email_alias`. Available options: `email_alias`.
`email`	`string`	No	The email address.
`is_confirmed`	`boolean`	No	Whether the email address has been confirmed.

Example

{
  "id": "11446498",
  "type": "email_alias",
  "email": "alias@example.com",
  "is_confirmed": true
}

Email aliases

A list of email aliases.

Attributes and example

Property	Type	Required	Description
`total_count`	`integer`	No	The number of email aliases.
`entries`	array of Email alias	No	A list of email aliases.

Example

{
  "total_count": 5000,
  "entries": [
    {
      "id": "11446498",
      "type": "email_alias",
      "email": "alias@example.com",
      "is_confirmed": true
    }
  ]
}

Last modified on July 9, 2026

Download file

List user's email aliases

⌘I

v2025.0

v2026.0

Email aliases resources

Email alias

Email aliases

​Email alias

​Email aliases

Email alias

Email aliases