Search available numbers
Search the provider's inventory for numbers available to purchase in a country (default US). Optional filters narrow the results. The country must be offerable (see GET /v1/phone-numbers/countries). Voice capability is always required; pass sms=true to only see numbers that can also text (SMS support is per-number, not per-country). Numbers a purchase would refuse are left out, and any result's phoneNumber can be bought exactly by passing it to POST /v1/phone-numbers/purchase.
Query parameters
Number type; defaults to the country's WhatsApp-safe type (the same name as on purchase, availability and kyc)
Area code or national dialing code the number must start with, e.g. 415 or 91
Alias of numberType, kept for existing callers
Alias of areaCode, kept for existing callers
City
Pattern to match within the number
true narrows the pool to SMS-capable numbers. Each result still carries its full features list for per-number capability badging.
Response
Available numbers.