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.

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

statusbooleanOptional

datalist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error