clerk.get_phone_number
Retrieve a Clerk phone number by id.
Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.
Returns the phone number summary.
Cost = 3 tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| phone_number_id | Yes | Clerk phone number id (idn_... or phn_...) to retrieve or modify. | |
| clerk_instance_id | No | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Clerk phone number id. | |
| verified | No | Whether the phone number is verified. | |
| phone_number | No | Phone number in E.164 format. | |
| default_second_factor | No | Whether this is the user's default second factor. | |
| reserved_for_second_factor | No | Whether the phone number is reserved for multi-factor authentication. |