Skip to main content
GET
Search Plivo Numbers
Read only Searches Plivo’s inventory of phone numbers that are available for purchase. This is the discovery step before buying: find a number in the country and pattern you want, then pass it to Buy Phone Number.

When to use this

  • Provisioning a new line: find an available number in the destination country before purchasing it for inbound or outbound calling.
  • Self-serve number pickers: let users of your own product browse available numbers before you buy one on their behalf.
If you bring your own number instead of buying one, skip this endpoint and use Link SIP Trunk.

Result

The response lists candidate numbers from Plivo’s inventory with their attributes; use the response schema on this page for the exact fields. Availability is live inventory and can change between searching and buying, so purchase promptly after picking a number. See API errors for the standard error format.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

country_iso
string
required

ISO country code (e.g., US, GB, CA)

Example:

"US"

type
string

Type of number (e.g., tollfree, local, mobile)

Example:

"tollfree"

region
string

City or state filter. For India, values such as Mumbai, Bengaluru or Chennai. For the United States, values such as California or Texas.

Example:

"Mumbai"

Response

Available Plivo numbers returned successfully.

success
enum<boolean>
required
Available options:
true
error
enum<boolean>
required
Available options:
false
statusCode
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required
timestamp
string<date-time>
required