List your Numbers

List Numbers in Workspace

List all purchased numbers assigned to the workspace. This endpoint provides various filtering options, including Country, Number Type and Capabilities.

GET/workspaces/{workspaceId}/numbers

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404422

OK

Body

application/json

results*array of Number (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', {
    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"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "subscription": {
        "status": "active",
        "subscribedAt": "2024-04-29T15:53:56.414Z",
        "updatedAt": "2024-04-29T15:53:56.414Z",
        "cancelledAt": "2024-04-29T15:53:56.414Z"
      },
      "configurations": {
        "voice": {
          "inbound": {
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "outbound": {
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "sms": {
          "inbound": {
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "outbound": {
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "mms": {
          "inbound": {
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "outbound": {
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "fax": {
          "inbound": {
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "outbound": {
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "whatsapp": {
          "connectorId": "123e4567-e89b-12d3-a456-426614174000",
          "connectorTemplateId": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "createdAt": "2024-04-29T15:53:56.414Z",
      "updatedAt": "2024-04-29T15:53:56.414Z",
      "requirements": [
        {
          "requirement": {
            "name": "text",
            "type": "kycForm",
            "scope": "number-activation",
            "selector": {
              "scope": "text",
              "numberType": "local",
              "countryCode": "AC"
            }
          },
          "status": "ok",
          "reference": "text"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}