Find numbers to claim
Searches the carrier for numbers that take calls; a self-hosted business gets only numbers that also take texts. Each offer expires after 5 minutes. On the cloud, a business on a paid plan gets numbers it buys. One without a paid plan gets free trial offers (trial: true) when the account the key acts as verified a mobile number for it in the dashboard, in a country with trials, and no trial was used; otherwise it gets a 409. The account a key acts as can search 20 times in 10 minutes; searches refused before that don’t count. Send replaces to find a replacement for an active number; a business can replace its number once.
Authorizations
An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.
Headers
The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.
Body
Defaults to the country of the business's time zone, or US. When the account the key acts as verified a mobile number for this business, that number's country decides. A deployment offers US and CA, and GB, AU and NZ once its carrier is set up for them.
US, CA, GB, AU, NZ Defaults to local. GB and AU numbers are always mobile, and NZ numbers local.
local, mobile, toll_free ^\d{1,6}$1 - 100A state or province, such as ON or NY.
1 - 641 - 16How many offers to return. Defaults to 10.
1 <= x <= 20The id of an active number to replace. The offers are then replacements, which only POST /phone-numbers/{phone_number_id}/replace accepts.