Docs

getEmailAddress()

Retrieves a single EmailAddress.

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

Parameters

  • Name
    emailAddressId
    Type
    string
    Description

    The ID of the email address to retrieve.

Example

const emailAddressId = 'idn_2V7JJ2R3O7KWHjCmUuEOJESHlPz'

const response = await clerkClient.emailAddresses.getEmailAddress(emailAddressId)

console.log(response)
/*
_EmailAddress {
  id: 'idn_123',
  emailAddress: 'alexis@clerk.dev',
  verification: _Verification {
    status: 'verified',
    strategy: 'from_oauth_google',
    externalVerificationRedirectURL: null,
    attempts: null,
    expireAt: null,
    nonce: null
  },
  linkedTo: [
    _IdentificationLink {
      id: 'idn_123',
      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 for more information.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on