List DIDs
list_didsList the authenticated customer's DIDs, optionally filtered by number (exact or number_contains), description_contains, country, DID Group, group features (voice, voice_out, t38, sms, sms_out, a2p, p2p, emergency, cnam_out — ALL listed must be supported), routing (trunk_id / sms_trunk_id, or has_trunk / has_sms_trunk false for the numbers routed NOWHERE), capacity (shared_capacity_group_id, capacity_pool_id, has_dedicated_channels) and status (terminated, blocked, awaiting_registration, is_configured — the get_did flag: routed AND with channels). Results are paginated. Returns each DID id, phone number, country ISO code, DID Group area, included channels, status flags, billing_cycles_count (renewal), description, creation time and expiration date (expires_at), plus pagination meta.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (default 1). | |
| number | No | Exact full DID phone number match. | |
| blocked | No | Filter by routing-blocked status. | |
| features | No | Capabilities the DID Group must support — every listed feature must be present (AND), like the panel Features filter. | |
| trunk_id | No | Voice IN Trunk UUID (from list_trunks) — only the DIDs routed to that trunk. | |
| has_trunk | No | false = only voice DIDs with NO trunk (calls go nowhere); true = only routed ones. | |
| page_size | No | Results per page (default 50, max 1000). | |
| terminated | No | Filter by terminated status. | |
| country_iso | No | Optional country filter by ISO 3166-1 alpha-2 code (e.g. US, GB), case-insensitive. Same value returned as `country_iso` on each DID. | |
| did_group_id | No | Optional DID Group UUID filter. | |
| sms_trunk_id | No | SMS trunk UUID (from list_sms_trunks) — only the DIDs whose incoming SMS route there. | |
| has_sms_trunk | No | false = only SMS-capable DIDs with NO SMS trunk; true = only routed ones. | |
| is_configured | No | The get_did flag: true = ready to carry traffic, false = missing routing or capacity. | |
| number_contains | No | Partial phone number match (substring of the full number). | |
| capacity_pool_id | No | Capacity pool UUID (from list_capacity_pools) — only the DIDs drawing on that pool. | |
| description_contains | No | Partial match on the DID description (substring, case-insensitive). | |
| awaiting_registration | No | Filter by awaiting-registration status. | |
| has_dedicated_channels | No | true = only DIDs with dedicated channels of their own; false = only those without. | |
| shared_capacity_group_id | No | Shared capacity group UUID (from list_capacity_groups) — only its member DIDs. |