Search for available phone numbers to purchase for a specific account. Supports filtering by number pattern, type, and capabilities.
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
Name
Type
Required
Example
Description
Authorization
string
Yes
Bearer token generated from the Leadway portal. See Authentication.
Version
string
Yes
2021-07-28
API version.
Path parameters
Name
Type
Required
Example
Description
locationId
string
Yes
ve9EPM428h8vShlRW1KT
The unique identifier of the account
Query parameters
Name
Type
Required
Example
Description
countryCode
string
Yes
US
ISO 3166-1 alpha-2 country code for which to search available numbers
numberTypes
string
No
local,tollFree
Comma-separated list of phone number types to search for (e.g. local, tollFree, mobile)
firstPart
string
No
830
Filter numbers that begin with this digit pattern
lastPart
string
No
825
Filter numbers that end with this digit pattern
anywhere
string
No
825
Filter numbers that contain this digit pattern anywhere
smsEnabled
boolean
No
True
Filter for numbers with SMS capability
mmsEnabled
boolean
No
True
Filter for numbers with MMS capability
voiceEnabled
boolean
No
True
Filter 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