`getPhoneNumber()`

Retrieves a single PhoneNumber.

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

Parameters

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const phoneNumberId = 'idn_123'

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

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.

Last updated on Feb 20, 2025