List your Numbers

Get a list of all Long code numbers assigned to your workspace.

You can filter your list of numbers using any of th following attributes:

• countryCode: 2 digit ISO code of the country, example: US for United States, we follow iso3166-1 standard.

• types: types of numbers your are searching for. Check API spec for allowed values.

• capabilities: the capabilities of the number (sms, mms, voice, whatsapp). Check API spec for allowed values..

• numberString: search numbers by their leading digits.

List Workspace Long Code Numbers

GET/workspaces/{workspaceId}/numbers-long-code

Path parameters

workspaceId*string

Query parameters

Response

200

OK

Body

application/json

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.

results*array of Numbers_WorkspaceLongCodeNumber (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/numbers-long-code', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "endpointId": "123e4567-e89b-12d3-a456-426614174000",
      "numberString": "text",
      "countryCode": "text",
      "type": "local",
      "capabilities": {
        "voice": {
          "inbound": false,
          "outbound": false
        },
        "sms": {
          "inbound": false,
          "outbound": false
        },
        "mms": {
          "inbound": false,
          "outbound": false
        }
      },
      "createdAt": "2024-10-22T10:10:44.117Z",
      "updatedAt": "2024-10-22T10:10:44.117Z",
      "order": {
        "countryCode": "text",
        "type": "local",
        "capabilities": [
          "voice"
        ],
        "prefix": "text",
        "status": "draft",
        "createdAt": "2024-10-22T10:10:44.117Z",
        "updatedAt": "2024-10-22T10:10:44.117Z"
      },
      "deprovisionAt": "2024-10-22T10:10:44.117Z",
      "endpoint": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "long-code-number",
        "instanceId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "capabilities": [
          {
            "name": "sms",
            "inbound": {
              "status": "active",
              "issues": [
                "subscription-is-not-active"
              ]
            },
            "outbound": {
              "status": "active",
              "destinationStatuses": {
                "active": 0,
                "inactive": 0,
                "available": 0,
                "unavailable": 0
              },
              "supportsDestinations": false,
              "issues": [
                "subscription-is-not-active"
              ]
            }
          }
        ],
        "dependencies": [
          {
            "type": "connector",
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateRef": "text",
            "capabilities": [
              "voice"
            ]
          }
        ],
        "issues": [
          "subscription-is-not-active"
        ],
        "provisioningStatus": "provisioned",
        "createdAt": "2024-10-22T10:10:44.117Z",
        "updatedAt": "2024-10-22T10:10:44.117Z"
      }
    }
  ]
}