GET /api/v1/phone_numbers/search
Search available phone numbers for purchase

Returns a list of available phone numbers for sale. Can be used with POST /api/v1/phone_numbers?requested_number= to purchase a number.

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" \
"https://[your-subdomain].trackdrive.com/api/v1/phone_numbers/search?toll_free=false&prefix=415"
      

Response Example

{
  "status": 200,
  "success": true,
  "phone_number_search_results": [
    {
      "id": "+14154151864",
      "legacy_id": "+14154151864",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14154151864",
      "country": "US"
    },
    {
      "id": "+14154471210",
      "legacy_id": "+14154471210",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14154471210",
      "country": "US"
    },
    {
      "id": "+14155297950",
      "legacy_id": "+14155297950",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14155297950",
      "country": "US"
    },
    {
      "id": "+14155868810",
      "legacy_id": "+14155868810",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14155868810",
      "country": "US"
    },
    {
      "id": "+14156952675",
      "legacy_id": "+14156952675",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14156952675",
      "country": "US"
    },
    {
      "id": "+14156978735",
      "legacy_id": "+14156978735",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14156978735",
      "country": "US"
    },
    {
      "id": "+14158677640",
      "legacy_id": "+14158677640",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14158677640",
      "country": "US"
    },
    {
      "id": "+14158817332",
      "legacy_id": "+14158817332",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14158817332",
      "country": "US"
    },
    {
      "id": "+14159259977",
      "legacy_id": "+14159259977",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14159259977",
      "country": "US"
    },
    {
      "id": "+14159415711",
      "legacy_id": "+14159415711",
      "type": "PhoneNumberSearchResult",
      "phone_number": "+14159415711",
      "country": "US"
    }
  ],
  "metadata": {
    "root": "phone_number_search_results",
    "page": 1,
    "total_pages": 0,
    "per_page": 25,
    "total_count": 10,
    "next_cursor": 0.0
  }
}

Params

Param name	Description Validations
country Optional	Two-letter country code (default: US) Validations: Must be a String
toll_free Optional	Whether to search toll-free numbers Validations: Must be one of: true, false.
prefix Optional	Restrict by area code (NPA). Example: 415, 209, 719 Validations: Must be a String
query Optional	Full or partial phone number to match Validations: Must be a String