Devices

Get devices list

Retrieve the list of devices (extensions) in your account.

When to use. List and audit the devices available for registration. To fetch a single device, use GET /devices/{id}.

Filtering and shape. Filter, order, limit and select fields by any response field. The response is wrapped as { "devices": [ ... ] }.

Example. GET /api/devices/limit/50;0

get/{sub_domain}/api/devices

Request

  • Base URL
    https://api.commpeak.com/pbx
  • URL
    https://api.commpeak.com/pbx/{sub_domain}/api/devices
  • Auth
    API key in header Authorization

Path parameters

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.