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

​
Email alias

An email alias for a user.
PropertyTypeRequiredDescription
idstringNoThe unique identifier for this object.
typeenum<string>NoThe value will always be email_alias. Available options: email_alias.
emailstringNoThe email address.
is_confirmedbooleanNoWhether 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.
PropertyTypeRequiredDescription
total_countintegerNoThe number of email aliases.
entriesarray of Email aliasNoA 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