Docs

getPhoneNumber()

Retrieves a single PhoneNumber.

function getPhoneNumber(phoneNumberId: string): Promise<PhoneNumber>

Parameters

  • Name
    phoneNumberId
    Type
    string
    Description

    The ID of the phone number to retrieve.

Example

const phoneNumberId = 'idn_123'

const response = await clerkClient.phoneNumbers.getPhoneNumber(phoneNumberId)

console.log(response)
/*
_PhoneNumber {
  id: 'idn_123',
  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 information.

Feedback

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

Last updated on