MQTT
Group State

Group State

🚫
NOTE: This part of the API does not exist yet.

The state of a group is derived from room states of multiple devices.

Topics

Subscribe to: api_client/<client_name>/<location_id>/group/<groupId>/state

Response

Not retained
QoS: 0

{
  "name": "Apartment 101",
  "timestamp": "2026-02-11T12:28:39.686400253Z",

  "roomStates": [
    {
      "id": "f3e1c2d4-5b6a-4c7d-8e9f-0a1b2c3d4e5f",
      "name": "Bedroom",
      "timestamp": "2026-02-11T12:28:39.686400253Z",
      "privacyMode": false,
      "humanPresent": true,
      "zones": [
        {
          "id": "5403bc21-834f-443e-bdfb-2993ab4044a7",
          "kind": "bed",
          "description": "Bed next to window.",
          "occupied": false
        }
      ],
      "humans": [
        {
          "zoneId": "5403bc21-834f-443e-bdfb-2993ab4044a7",
          "position": "lying_left_lateral"
        }
      ]
    }
  ]
}
  • name: Name of the group, e.g., “Apartment 101”, “Household”
  • timestamp: Timestamp of when the state was generated
  • roomStates: List of room states
    • id: Unique identifier of the room (UUID), changes with every update of the room state, e.g. present to not present. Can be used to retrieve event footage for the room state.
    • name: Name of the room, e.g., “Bedroom”, “Bathroom”
    • timestamp: Timestamp of when the state was generated
    • privacyMode: Whether the privacy mode is active on the device
    • humanPresent: Whether a human is present in the room, see Detection Logic for more info
    • zones: A list of zones in the room, which are defined areas such as beds, doors, and seats
      • id: Unique identifier of the zone (UUID)
      • kind: Kind of the zone; expected values are bed, doorExit, doorBathroom, seat
      • description: Description of the zone, e.g., “Bed next to window.”
      • occupied: Whether the zone is currently occupied by a human, see Detection Logic for more info
    • humans: A list of humans currently in the zone, if any.
      • zoneId: The id of the zone the human is currently in, or null if the human is present in the room but not in any specific zone.
      • position: Positions of the humans in the zone
Room StateZigBee