Search rentable phone numbers in inventory

GET

https://api.smallest.ai/atoms/v1/product/get-available-numbers

Searches the telephony provider’s inventory for available numbers matching the requested country (and optional area code). Returns up to 5 candidates per call.

Use the returned phoneNumber value in POST /product/rent-number to actually rent it.

Searches the telephony provider's inventory for available numbers matching the requested country (and optional area code). Returns up to 5 candidates per call. Use the returned `phoneNumber` value in [`POST /product/rent-number`](#operation/rentPhoneNumber) to actually rent it.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

countryCodestringRequired

ISO 3166-1 alpha-2 country code (e.g. US, IN, GB).

providerenumRequired

Telephony provider to search.

Allowed values:

areaCodestringOptional

Optional area-code / region filter — provider-dependent (US area codes for plivo/twilio, etc.).

Response

Successful response

statusboolean

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

1	import requests
2
3	url = "https://api.smallest.ai/atoms/v1/product/get-available-numbers"
4
5	querystring = {"countryCode":"US","provider":"plivo"}
6
7	headers = {"Authorization": "Bearer <token>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"status": true,
3	"data": [
4	{
5	"phoneNumber": "13183747513",
6	"countryCode": "US",
7	"provider": "plivo",
8	"areaCode": "Louisiana"
9	}
10	]
11	}