Devices
Get device
Retrieve a single device by its extension.
When to use. Drill-down to the full detail of one device, for example from a list row.
Parameters. id (path): the extension of the device to look up. Returns an error if no device with that extension exists.
Shape. { "devices": [ <device> ] }, a single-element array that matches the list endpoint's envelope.
get/{sub_domain}/api/devices/{id}
Request
- Base URLhttps://api.commpeak.com/pbx
- URLhttps://api.commpeak.com/pbx/{sub_domain}/api/devices/{id}
- AuthAPI key in header Authorization
Path parameters
idinteger required
Device extension.
sub_domainstring required
PBX Name (subdomain)
Response
Successful Response
Example response
{
"devices": [
{
"created_at": "2023-07-13 09:47:56",
"extension": 199,
"id": 1,
"name": "dev-agent",
"password": "69a9f6eddfd521fce4366c945a95cab5"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.