Skip to main content
GET
/
v2
/
admin
/
devices
/
{id}
Get Device
curl --request GET \
  --url https://api.voxo.co/v2/admin/devices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "name": "<string>",
  "mac": "<string>",
  "tenant": {
    "id": 123,
    "name": "<string>"
  },
  "deviceModel": {
    "id": 123,
    "name": "<string>"
  },
  "extensions": [
    {
      "lineNumber": 123,
      "id": 123,
      "name": "<string>",
      "number": "<string>",
      "peerName": "<string>"
    }
  ],
  "buttonLayouts": [
    {
      "id": 123,
      "type": "<string>",
      "name": "<string>",
      "startKey": 123,
      "endKey": 123
    }
  ],
  "phonebooks": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "config": [
    {
      "name": "<string>",
      "label": "<string>",
      "value": "<string>",
      "displayValue": "<string>"
    }
  ],
  "userAgent": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Device ID

Pattern: ^[1-9]\d*$

Response

Device with full settings profile

id
number
required

Device ID

name
string
required

Device name

mac
string
required

MAC address

tenant
object
required

Owning tenant

deviceModel
object
required

Phone model

extensions
object[]
required

Assigned line extensions

buttonLayouts
object[]
required

Assigned button layouts

phonebooks
object[]
required

Assigned phonebooks

config
object[]
required

Device-level configurable fields. One entry per av_autoprovisionvalues row of av_type = 'PHONE' for this device, joined to its al_autoprovisionlabels row for the human-readable label. displayValue is the mapped label for select/bool/checkbox/radio fields (per the template's options); equals value otherwise.

userAgent
string
required

SIP user agent of the device's primary line (phLine1ExId). Empty string when no primary line is set or the phone is not currently registered.