List numbers available to buy
Lists the phone numbers the workspace can buy, priced in its wallet currency, newest first, 100 at a time. The price shown is the price charged, with VAT where it applies. Numbers held by another workspace are left out. Filter by country or search.
Requires: desk.admin scope, workspace owner or admin.
Authorization
bearerAuth A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Query Parameters
Only numbers in this country, such as KE. A country whose currency is not the wallet's returns nothing.
Digits the number contains. Spaces, dashes and a leading plus or zero are ignored.
Page size: 100 by default, and 100 at most.
next_cursor from the previous page.
Response
OK
Example
{ "data": [ { "inventory_id": "2dfe9c17-9ac4-4b9f-998b-12b936732f05", "e164": "+254712345678", "country": "KE", "capabilities": [ "example" ], "monthly_price_minor": 3000, "monthly_vat_minor": 1, "monthly_total_minor": 1, "vat_rate_bps": 1, "first_charge_net_minor": 1, "first_charge_vat_minor": 1, "first_charge_total_minor": 1, "vat_applied": false, "currency": "KES", "inbound_per_min_minor": 1, "outbound_per_min_minor": 1 } ], "next_cursor": "eyJvIjoyNX0", "has_more": false}datarequiredobject[]inventory_idrequiredstring (uuid)e164requiredstringcountryrequiredstringcapabilitiesrequiredstring[]monthly_price_minorrequiredintegermonthly_vat_minorintegermonthly_total_minorintegervat_rate_bpsintegerfirst_charge_net_minorrequiredintegerfirst_charge_vat_minorrequiredintegerfirst_charge_total_minorrequiredintegervat_appliedrequiredbooleancurrencyrequiredstringThe currency code of the money in this report, for example KES. Write money figures with it. Left out when the report has no money.inbound_per_min_minorrequiredintegeroutbound_per_min_minorrequiredintegernext_cursorrequiredstring | nullhas_morerequiredbooleancurl -X GET "https://api.sautidesk.com/v1/desk/numbers/available"