getPhoneNumber()
Retrieves a single PhoneNumber by its ID, if the ID is valid.
function getPhoneNumber: (phoneNumberId: string) => Promise<PhoneNumber>;- Name
phoneNumberId- Type
string- Description
The ID of the phone number to retrieve.
const phoneNumberId = 'idn_2bxwW8Fa5Y53QcESgQ6HkTo0cgh';
const response = await clerkClient.phoneNumbers.getPhoneNumber(phoneNumberId);
console.log(response);
/*
_PhoneNumber {
id: 'idn_2bxwW8Fa5Y53QcESgQ6HkTo0cgh',
phoneNumber: '15551234567',
reservedForSecondFactor: false,
defaultSecondFactor: false,
verification: _Verification {
status: 'verified',
strategy: 'admin',
externalVerificationRedirectURL: null,
attempts: null,
expireAt: null,
nonce: null
},
linkedTo: []
}
*/Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint GET/phone_numbers/{phone_number_id}. See the BAPI reference for more details.