List user's email aliases | Sample

1 parameter

user_idstringrequired

The ID of the user.

2 status codes

200Returns a collection of email aliases.

total_countintegeroptional

The number of email aliases.

entriesarray<EmailAlias>optional

A list of email aliases.

defaultAn unexpected client error.

typestringoptional

The value will always be `error`.

Allowed:error

statusintegeroptional

The HTTP status of the response.

codestringoptional

A Box-specific error code.

Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed

messagestringoptional

A short message describing the error.

context_infoobjectoptional

A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.

help_urlstringoptional

A URL that links to more information about why this error occurred.

request_idstringoptional

A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: {
    clientId: process.env.CLIENT_ID,
    clientSecret: process.env.CLIENT_SECRET,
  },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.emailAliases.list({ userId: "c0a80123-4567-89ab-cdef-0123456789ab" });

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

Request

Response

Errors