POST
/
api
/
v2
/
phoneNumber
/
search
/
local
/
locality
Search for local numbers by locality
curl --request POST \
  --url https://api.vida.dev/api/v2/phoneNumber/search/local/locality \
  --header 'Content-Type: application/json' \
  --data '{
  "city": "Austin",
  "region": "TX",
  "country": "US"
}'
{
  "success": true,
  "message": "Success"
}

Authorizations

​
token
string
query
required

Vida API Token

Body

application/json
​
city
string

City you are searching for. If the particular city is unavailable, phone numbers from a 10 mile radius will be returned

Example:

"Austin"

​
region
string

Region for the search. If searching within the U.S., this will be the state

Example:

"TX"

​
country
string

Country for the search

Example:

"US"

Response

Successfully retrieved available numbers

​
success
boolean
Example:

true

​
message
string
Example:

"Success"