Search for available phone numbers to purchase for a specific account. Supports filtering by number pattern, type, and capabilities.

http
GET https://services.leadconnectorhq.com/phone-system/numbers/location/{locationId}/available

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
locationIdstringYesve9EPM428h8vShlRW1KTThe unique identifier of the account

Query parameters

NameTypeRequiredExampleDescription
countryCodestringYesUSISO 3166-1 alpha-2 country code for which to search available numbers
numberTypesstringNolocal,tollFreeComma-separated list of phone number types to search for (e.g. local, tollFree, mobile)
firstPartstringNo830Filter numbers that begin with this digit pattern
lastPartstringNo825Filter numbers that end with this digit pattern
anywherestringNo825Filter numbers that contain this digit pattern anywhere
smsEnabledbooleanNoTrueFilter for numbers with SMS capability
mmsEnabledbooleanNoTrueFilter for numbers with MMS capability
voiceEnabledbooleanNoTrueFilter for numbers with voice capability

Responses

200 - Successfully retrieved list of available phone numbers
  • fingerprintId (string, required): Unique fingerprint ID for this search result, required when purchasing one of the returned numbers Example: 1773314252953

  • numbers (object[], required): List of available phone numbers matching the search criteria

    • phoneNumber (string, required): E.164 formatted phone number Example: +18705871861

    • friendlyName (string, required): Human-readable formatted phone number Example: (870) 587-1861

    • isoCountry (string, required): ISO 3166-1 alpha-2 country code Example: US

    • lata (string): Local Access and Transport Area code Example: 528

    • locality (string): City or locality of the number Example: Wynne

    • rateCenter (string): Rate center of the number Example: WYNNE

    • latitude (string): Latitude coordinate of the number's account Example: 35.241800

    • longitude (string): Longitude coordinate of the number's account Example: -90.846000

    • region (string): State or region abbreviation Example: AR

    • postalCode (string): Postal code of the number Example: 72396

    • addressRequirements (string, required): Address requirements for purchasing this number Possible values: 'none', 'any', 'local', 'foreign' Example: none

    • beta (boolean, required): Whether this is a beta number Example: False

    • capabilities (object, required): Communication capabilities supported by this number

      • MMS (boolean): Example: True

      • SMS (boolean): Example: True

      • voice (boolean): Example: True

    • price (object): Pricing information for this number

      • number_type (string): Type of number for billing purposes Example: local

      • price (number): Monthly price for this number Example: 1.15

      • price_unit (string): Currency unit for the price Example: USD

json
{
  "fingerprintId": "1773314252953",
  "numbers": [
    {
      "phoneNumber": "+18705871861",
      "friendlyName": "(870) 587-1861",
      "lata": "528",
      "locality": "Wynne",
      "rateCenter": "WYNNE",
      "latitude": "35.241800",
      "longitude": "-90.846000",
      "region": "AR",
      "postalCode": "72396",
      "isoCountry": "US",
      "addressRequirements": "none",
      "beta": false,
      "capabilities": {
        "MMS": true,
        "SMS": true,
        "voice": true
      },
      "price": {
        "number_type": "local",
        "price": 1.15,
        "price_unit": "USD"
      }
    }
  ]
}
400 - Bad request - Invalid parameters
  • message (string): Example: countryCode is required

  • error (string): Example: Bad Request

  • statusCode (number): Example: 400

json
{
  "message": "countryCode is required",
  "error": "Bad Request",
  "statusCode": 400
}
401 - Unauthorized
json
{}
500 - Internal server error

Example

curl -X GET 'https://services.leadconnectorhq.com/phone-system/numbers/location/YOUR_locationId/available' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?