`getEmailAddress()`

Retrieves a single EmailAddress by its ID.


function getEmailAddress: (emailAddressId: string) => Promise<EmailAddress>;

`getEmailAddress()` parameters

Name	Type	Description
`emailAddressId`	`string`	The ID of the email address to retrieve.

`getEmailAddress()` example


const emailAddressId = 'idn_2V7JJ2R3O7KWHjCmUuEOJESHlPz';
 
const response = await clerkClient.emailAddresses.getEmailAddress(emailAddressId);
 
console.log(response);
/*
_EmailAddress {
  id: 'idn_2V7JJ2R3O7KWHjCmUuEOJESHlPz',
  emailAddress: 'alexis@clerk.dev',
  verification: _Verification {
    status: 'verified',
    strategy: 'from_oauth_google',
    externalVerificationRedirectURL: null,
    attempts: null,
    expireAt: null,
    nonce: null
  },
  linkedTo: [
    _IdentificationLink {
      id: 'idn_2V7JJ4xpXyj0mazg3lsLYOUit9t',
      type: 'oauth_google'
    }
  ]
}
*/

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/email_addresses/{email_address_id}. See the BAPI reference(opens in a new tab) for more details.

Last updated on February 22, 2024

getEmailAddress() parameters

getEmailAddress() example

Backend API (BAPI) endpoint

`getEmailAddress()` parameters

`getEmailAddress()` example