Skip to main content
GET
Search available numbers

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.

Headers

Kallabot-Version
enum<string>

The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.

Available options:
2026-11-07
Example:

"2026-11-07"

Query Parameters

country_code
string
required
Required string length: 2
number_type
enum<string>
default:local
Available options:
local,
mobile,
toll_free,
national,
shared_cost
area_code
string | null
Maximum string length: 6
contains
string | null
Maximum string length: 24
match
enum<string>
default:anywhere
Available options:
anywhere,
start,
end
dial_code
string | null
Maximum string length: 4
locality
string | null
Maximum string length: 80
region
string | null
Maximum string length: 40
postal_code
string | null
Maximum string length: 12
near_number
string | null
Pattern: ^\+?[1-9][0-9]{7,14}$
distance
integer | null
Required range: 1 <= x <= 500
sms
boolean
default:false
mms
boolean
default:false
fax
boolean
default:false
exclude_address
enum<string>
default:none
Available options:
any,
local,
foreign,
none
beta
boolean
default:true
limit
integer
default:50

How many numbers to return (one page; search again with other filters for more).

Required range: 1 <= x <= 100
cursor
string | null
Maximum string length: 512

Response

Successful Response

data
AvailableNumber · object[]
required

The items on this page, in the list's order.

has_more
boolean
required

True when another page follows this one.

next_cursor
string | null

Pass as cursor to get the next page. Null on the last page. Opaque: don't parse it.