Box Developer Documentation
Log in
Latest version

List user's email aliases

get
https://api.box.com/2.0
/users/:user_id/email_aliases

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Retrieves all email aliases for a user. The collection does not include the primary login for the user.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The ID of the user.

Response

application/jsonEmail aliases

Returns a collection of email aliases.

application/jsonClient error

An unexpected client error.

get
List user's email aliases
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versionig strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/users/12345/email_aliases" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.emailAliases.getUserEmailAliases(newUser.id);
Python v10
client.email_aliases.get_user_email_aliases(new_user.id)
.NET v10
await client.EmailAliases.GetUserEmailAliasesAsync(userId: newUser.Id);
Swift v10
try await client.emailAliases.getUserEmailAliases(userId: newUser.id)
Java v10
client.getEmailAliases().getUserEmailAliases(newUser.getId())
Java v4
BoxUser user = new BoxUser(api, "0");
Collection<EmailAlias> emailAliases = user.getEmailAliases();
Python v3
user_id = '33333'
user = client.user(user_id)
email_aliases = user.get_email_aliases()
for alias in email_aliases:
    print(f'User {user.id} has email alias {alias.email}')
.NET v5
BoxCollection<BoxEmailAlias> aliases = await client.UsersManager
    .GetEmailAliasesAsync(userId: "33333");
Node v3
client.users.getEmailAliases('33333')
    .then(emailAliases => {
        /* emailAliases -> {
            total_count: 2,
            entries: 
            [ { type: 'email_alias',
                id: '1234',
                is_confirmed: true,
                email: 'user+foo@example.com' },
                { type: 'email_alias',
                id: '1235',
                is_confirmed: true,
                email: 'user+bar@example.com' } ] }
        */
    });

Response Example

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