Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
alternateEmailAddress

List alternate emails

Gets a list of the alternate emails for the specified user.

Who can use this operation?

  • Plans: Only Enterprise and Advanced Work Management plans with this feature activated by Support can use this method. If you want to activate this feature, please contact Support.
  • Permissions: System Admin

Note: For pagination guidance, refer to Pagination.

get/users/{userId}/alternateemails

Response

IndexResult object containing an array of AlternateEmail objects.

Note: For pagination guidance, refer to Pagination.

pageNumbernumber

The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned.

pageSizenumber nullable

The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.

totalPagesnumber

The total number of pages in the full result set.

totalCountnumber

The total number of items in the full result set.

Example response

{
  "pageNumber": 1,
  "pageSize": 50,
  "totalPages": 25,
  "totalCount": 136,
  "data": [
    {
      "id": 8150532427671428,
      "confirmed": true,
      "email": "johnathan.doe@smartsheet.com"
    }
  ]
}