devices

Api reference content
get/api/devices

Retrives all devices connected to the current AIP network. Results can be paged with query parameters start and limit.

Parameters

ParameterPlaceRequiredDescription
startqueryrequiredFirst item in page
limitqueryrequiredNumber of items in page
typequeryrequiredFilter for type of device

Responses

StatusDescription
200
application/json
{
  "_links": {
    "next": "string",
    "base": "string",
    "self": "string"
  },
  "start": "double",
  "limit": "double",
  "results": [
    {
      "mac": "string",
      "name": "string",
      "model": "string",
      "type": "transmitter | intercom | pc-gateway | desk | microphone | player | pc-server | player-amplifier | gate | sonometer",
      "channel": {
        "id": "string",
        "name": "string",
        "source": "string",
        "type": "bgm | message | event | voip"
      },
      "current_volume": "double",
      "ip": "string",
      "sensors": "[double]",
      "sensor_count": "double"
    }
  ]
}
400
application/json
{
  "errors": "[string]"
}