Skip to content

Function: getUserEmail() ​

ts
function getUserEmail(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  accountId?: string;
  email?: string;
}>;

Defined in: src/cloud/api/users.ts:192

Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is only available to apps approved by Atlassian, according to these guidelines. For Forge apps, this API only supports access via asApp() requests.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ accountId: string; }-
parameters.accountIdstringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; accountId?: string; email?: string; }>