GET
/phone_numbers/{phone_number_id}Retrieve a phone number
Retrieves the details of a phone number. Use its identifier to get the phone number, verification details, linked resources, and reservation status.
phone_number_idstringrequired
The ID of the phone number to retrieve.
200Returns the phone number object, including its verification details, linked resources, reservation flags, timestamps, and any backup codes.
idstringoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
phone_numberstringrequired
reserved_for_second_factorbooleanoptional
default_second_factorbooleanoptional
reservedbooleanrequired
verificationobjectrequired
linked_toarray<object>required
backup_codesarray<string>optional
created_atintegerrequired
Unix timestamp of creation
updated_atintegerrequired
Unix timestamp of creation
400Returned when the request is unsuccessful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Returned when authentication is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Returned when authorization is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the phone number is not found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
Error handling
A 400 is returned when the request is unsuccessful; a 401 when authentication is invalid; a 403 when authorization is invalid; and a 404 when the phone number is not found. The phone_number_id path parameter must identify the phone number to retrieve.