Skip to main content
GET
/
api
/
v1
/
twilio
/
search
Search available Twilio phone numbers
curl --request GET \
  --url https://prod.featherhq.com/api/v1/twilio/search \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "phoneNumbers": [
    {
      "friendlyName": "<string>",
      "phoneNumber": "<string>",
      "lata": "<string>",
      "rateCenter": "<string>",
      "latitude": "<string>",
      "longitude": "<string>",
      "region": "<string>",
      "postalCode": "<string>",
      "isoCountry": "<string>",
      "addressRequirements": "<string>",
      "capabilities": {
        "voice": true,
        "SMS": true,
        "MMS": true,
        "fax": true
      }
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Query Parameters

areaCode
string
Example:

"415"

contains
string
Example:

"555"

limit
number
default:20
Required range: 1 <= x <= 1000
Example:

20

Response

Available phone numbers retrieved successfully

success
boolean
required
phoneNumbers
object[]
required