getEmailAddress()
Retrieves a single EmailAddress by its ID.
function getEmailAddress: (emailAddressId: string) => Promise<EmailAddress>;- Name
emailAddressId- Type
string- Description
The ID of the email address to retrieve.
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 for more details.
Feedback
Last updated on