List all numbers

Responses

Successfully retrieved the number(s)

application/json

Schema

Example (from schema)

Schema

data object[]

Array [

id string

The ID of the number

label string nullable

The label of the number

number string

The phone number in E.164 format

localizedNumber string

The phone number in localized format

status string

Possible values: [ACTIVE, SUSPENDED, CANCELLED, PENDING_CANCEL, PARKED, PENDING_PARKING, PENDING_PORTING_IN, PENDING_REGION_VALIDATION, PENDING_ACTIVATION]

The status of the number

activationDate date-time nullable

The date and time the number was activated

cancelDate date-time nullable

The date and time the number was cancelled

activeUserIds string[]

An array of active user ids included in the forwarding / voice menu features.

insights object

enabled boolean

Whether insights are enabled for the number

]

{
  "data": [
    {
      "id": "64b8e900cbe7501ee8467d3e",
      "label": "Rinkel",
      "number": "+31850609000",
      "localizedNumber": "085 060 9000",
      "status": "ACTIVE",
      "activationDate": "2020-01-01T12:00:00.000Z",
      "cancelDate": null,
      "activeUserIds": [
        "66ab605ddac0af208d5f0dab",
        "66ab6061210ac5e3539eec4f",
        "66ab606660166d5dd6779732"
      ],
      "insights": {
        "enabled": true
      }
    }
  ]
}

List all numbers​

List all numbers