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.
Works without an API key. Keyless calls get up to 12 results with the middle digits masked (maskedNumber), each with a claimId and a claimUrl: a signup link that lands a person on the dashboard's confirm step with that number picked, so an agent can search for a user and hand them one link. Keyless calls are rate limited per IP and results are cached for a few minutes. With an API key you get full numbers and no claim fields.
Query parameters
ISO code, or auto on the keyless shape to search the caller's own country (from their IP) near their city, falling back to US.
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.
true returns the keyless shape (masked numbers with claimId and claimUrl) even when you send an API key, e.g. to hand a user a signup link for a number.
Response
Available numbers.