List team phone numbers
Retrieves the list of phone numbers provisioned for your team. Each number includes its assignment (user, IVR, conference, fax, or unassigned), country, and configuration. The total count is in the list_count field.
Five boolean filters allow you to select numbers by assignment type. By default, is_available is true and all others are false. Set a filter to true to include that category. If is_available is false, at least one other filter must be true.
Permission: Numbers Read required.
Monitoring impact:
- OFF: Returns only your own numbers (numbers assigned to your user). All filter parameters are ignored — the response always contains your numbers regardless of filters.
- ON: Returns all team numbers with full filter support (is_ivr, is_user, is_conference, is_fax, is_available).
Query parameters
Include numbers assigned to users. Default: false. Only effective when Monitoring is ON.
Include numbers assigned to IVRs (Interactive Voice Response). Default: false. Only effective when Monitoring is ON.
Include numbers used for fax. Default: false. Only effective when Monitoring is ON.
Include numbers assigned to conference rooms. Default: false. Only effective when Monitoring is ON.
Include unassigned (available) numbers. Default: true. If set to false, at least one other filter must be true. Only effective when Monitoring is ON.
Response
Successful operation — returns the list of numbers.
Example response
{
"list_count": 1,
"list": [
{
"number": 33184800000,
"label": "myfavoritenumber",
"type": "PHONE",
"user_id": 60907,
"ivr_id": 60908,
"conference_id": 60908,
"format": {
"raw": 184800000,
"country_code": "33",
"country": "FR",
"e164": "+33184800000",
"international": "+33 1 84 80 00 00",
"international_alt": "33184800000",
"national": "01 84 80 00 00",
"national_alt": "0184800000",
"rfc3966": "tel:+33-1-84-80-00-00"
}
}
]
}