Ask for a number we don't stock
Asks our team to source numbers the live inventory doesn’t have: country_code (two letters), number_type (local, mobile, national or toll_free), optional area, quantity (up to 100) and notes. We quote it, and the numbers arrive in this workspace once fulfilled. Returns 201 with the request.
Needs a personal key (kbp_live_…): it acts as you.
Scopes: number:write
Authorizations
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
A unique key (a UUID works) for this request. Retrying with the same key returns the first answer instead of running twice.
255The 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.
2026-11-07 "2026-11-07"
Body
The country, ISO 3166 alpha-2.
^[A-Z]{2}$The number type.
local, mobile, national, toll_free A city or area code, if it matters.
80How many numbers.
1 <= x <= 100Anything our team should know.
1000Response
Successful Response
The request id.
ISO 3166 alpha-2.
The number type asked for.
How many numbers.
Where the request stands.
Numbers added to your workspace for it.
ISO 8601.
ISO 8601.
The city or area asked for.
Your notes for our team.
Our team's reply.