Search Available Numbers

List available Numbers in Inventory

Retrieve a list of available inventory numbers

GET/workspaces/{workspaceId}/numbers-available

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200400

OK

Body

application/json

results*array of NumberAvailable (object)

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/numbers-available', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "results": [
    {
      "type": "local",
      "capabilities": {
        "sms": {
          "inbound": false,
          "outbound": false
        },
        "voice": {
          "inbound": false,
          "outbound": false
        },
        "mms": {
          "inbound": false,
          "outbound": false
        },
        "fax": {
          "inbound": false,
          "outbound": false
        }
      },
      "number": "text",
      "country": "AC",
      "monthlyRecurringPrice": {
        "currencyCode": "EUR"
      },
      "complianceRequirements": [
        {
          "name": "text",
          "type": "kycForm",
          "scope": "number-activation",
          "selector": {
            "scope": "text",
            "numberType": "local",
            "countryCode": "AC"
          }
        }
      ]
    }
  ],
  "nextPageToken": "text"
}