BObox
Email aliases

List user's email aliases

Changed on

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

get/users/{user_id}/email_aliases

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/users/{user_id}/email_aliases
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Path parameters

user_idstring required

The ID of the user.

Response

Returns a collection of email aliases.

total_countinteger

The number of email aliases.

Example response

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

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status