Search phone numbers
Searches for available phone numbers to purchase.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.
Learn more about API scopes.
Query parameters
An areacode to search within.
Search for either local or toll-free numbers. Defaults to local.
A string of 3 to 7 digits that should be used as the start of a number. Cannot be used in combination with contains or ends_with.
A string of 3 to 7 digits that should appear somewhere in the number. Cannot be used in combination with starts_with or ends_with.
A string of 3 to 7 digits that should be used as the end of a number. Cannot be used in combination with starts_with or contains.
The maximum number of matches to return. Upper limit of 100. Defaults to 50.
A region or state to search within. Must be an ISO 3166-2 alpha-2 code, i.e. TX for Texas. Only supported for local searches; not supported when number_type is toll-free.
A specific City to search within. Must be used in combination with region. Only supported for local searches; not supported when number_type is toll-free.
Response
The request has succeeded.
Example response
{
"data": [
{
"number": "+15551234567",
"region": "CA",
"city": "Los Angeles"
}
]
}