ADT · Schema

Device

A security device (sensor, camera, lock, or smart home device).

Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Properties

Name Type Description
id string Unique identifier of the device.
name string Display name of the device.
type string Type of device.
status string Current status of the device.
zone string Security zone the device belongs to.
batteryLevel integer Battery level percentage (0-100) for battery-powered devices.
lastActivity string Timestamp of last device activity.
View JSON Schema on GitHub

JSON Schema

platform-api-device-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-schema/platform-api-device-schema.json",
  "title": "Device",
  "description": "A security device (sensor, camera, lock, or smart home device).",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the device.",
      "example": "dev-001"
    },
    "name": {
      "type": "string",
      "description": "Display name of the device.",
      "example": "Front Door Sensor"
    },
    "type": {
      "type": "string",
      "description": "Type of device.",
      "enum": [
        "sensor",
        "camera",
        "lock",
        "thermostat",
        "light",
        "doorbell",
        "smoke_detector",
        "flood_sensor"
      ],
      "example": "sensor"
    },
    "status": {
      "type": "string",
      "description": "Current status of the device.",
      "example": "closed"
    },
    "zone": {
      "type": "string",
      "description": "Security zone the device belongs to.",
      "example": "Zone 1 - Entry"
    },
    "batteryLevel": {
      "type": "integer",
      "description": "Battery level percentage (0-100) for battery-powered devices.",
      "example": 85
    },
    "lastActivity": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp of last device activity.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}