List Phone Numbers
listNumbersList the phone numbers your workspace rents: each has a numberId, the number (e164), country, what kind of number it is (mobile, local and so on), what it can carry (voice, sms), what it was bought for (type) and is used for now (uses: outbound or load caller ID, callback, survey or inbound), whether it is the default caller ID, its state (ordering, live, releasing, or failed when the carrier failed its order), activation status while ordering, monthly rate and when it was acquired. Also allowance: how many numbers the workspace may hold and how many are left, and whether new numbers are included in the workspace's custom agreement (includedInDeal, with its dealRef), in which case no rental or setup fee is charged for them. Takes no parameters. Use when: the user asks which numbers they have, what a number is used for, or why a number is not live yet. Read-only. Needs numbers:read (owner, admin or billing admin); other roles get 403.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "listNumbers"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| numbers | Yes | ||
| allowance | No | How many numbers this workspace may hold. Served alongside the numbers so a client never has to infer it from the plan — the limit is overridable per workspace, so "free plan, therefore none" is a rule that is true until someone grants an exception. Advisory: `POST /numbers/orders` enforces the limit itself and refuses on its own. This is what lets a UI say so first, and it is **absent** if the allowance could not be read — a billing hiccup does not blank the list. |