Abra GraphQL APIs
/
Home
/
Queries
/
alarms

alarms(homeId)
AlarmCollection

Arguments

homeId
ID!,non-nullrequired

Return type

alarms
[Alarm!]!,non-null
Query sample
query alarms($homeId: ID!) {
  alarms(homeId: $homeId) {
    alarms {
      id 
      state 
      triggeredAt 
      snoozeExpiresAt 
      areas {
        id 
        areaName 
        areaType 
        size 
        floor 
        children 
        devices(
          # Arguments Here
        ) {
          id 
          deviceType 
          name 
          serialNumber 
          imei 
          macAddress 
          ipAddress 
          roomPlacement 
          manufacturer {
            id 
            name 
            logo {
              __typename
              # ...DeviceManufacturerLogoFragment
            }
          }
          deviceTemplate(
            # Arguments Here
          ) {
            id 
            deviceType 
            name 
            primaryPairingMode 
            secondaryPairingModes 
            manufacturer {
              __typename
              # ...DeviceManufacturerFragment
            }
            image {
              __typename
              # ...DeviceTemplateImageFragment
            }
            imageWithBg {
              __typename
              # ...DeviceTemplateImageFragment
            }
            instructions {
              __typename
              # ...DeviceTemplateInstructionsFragment
            }
          }
          image {
            url 
            urlSmall 
            urlMedium 
            urlLarge 
          }
          favorite 
          favoriteChangedAt 
          registeredAt 
          canBeUnregistered 
          firmwareVersion 
          latestFirmware {
            variant 
            version 
            downloadUrl 
          }
          relayConfiguration {
            supportedDeviceTypes 
            endDeviceType 
          }
          ioModuleConfiguration {
            supportedConfigurations 
            configuration 
          }
          area {
            id 
            areaName 
            areaType 
            size 
            floor 
            children 
            devices(
              # Arguments Here
            ) {
              __typename
              # ...DeviceFragment
            }
            accessPolicies {
              __typename
              # ...HomeProfileActionAccessFragment
            }
          }
          traits {
            traitType 
            commands 
            attributes {
              __typename
              # ...TraitAttributeAvailableArmLevelsFragment
            }
          }
          accessPolicy {
            read 
            write 
            delete 
            expiresAt 
          }
        }
        accessPolicies {
          actionType 
          create 
          update 
          delete 
          read 
        }
      }
      notificationLifecycle {
        id 
        notifications {
          reason 
        }
      }
      alarmStationNotificationLifecycle {
        deviceEvents {
          deviceId 
          events {
            triggeredAt 
            eventType 
            status 
          }
        }
      }
    }
  }
}
Variables
{
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "alarms": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "state": "ALARM",
        "triggeredAt": "Example String",
        "snoozeExpiresAt": "Example String",
        "areas": [
          {
            "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
            "areaName": "Example String",
            "areaType": "BATHROOM",
            "size": 40,
            "floor": 40,
            "children": true,
            "devices": [
              {
                "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                "deviceType": "AIR_QUALITY_SENSOR",
                "name": "Example String",
                "serialNumber": "Example String",
                "imei": "Example String",
                "macAddress": "Example String",
                "ipAddress": "Example String",
                "roomPlacement": "Example String",
                "manufacturer": {
                  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                  "name": "Example String",
                  "logo": {
                    "__typename": "DeviceManufacturerLogo"
                  }
                },
                "deviceTemplate": {
                  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                  "deviceType": "AIR_QUALITY_SENSOR",
                  "name": "Example String",
                  "primaryPairingMode": "PLUG",
                  "secondaryPairingModes": [
                    "PLUG"
                  ],
                  "manufacturer": {
                    "__typename": "DeviceManufacturer"
                  },
                  "image": {
                    "__typename": "DeviceTemplateImage"
                  },
                  "imageWithBg": {
                    "__typename": "DeviceTemplateImage"
                  },
                  "instructions": {
                    "__typename": "DeviceTemplateInstructions"
                  }
                },
                "image": {
                  "url": "Example String",
                  "urlSmall": "Example String",
                  "urlMedium": "Example String",
                  "urlLarge": "Example String"
                },
                "favorite": true,
                "favoriteChangedAt": "Example String",
                "registeredAt": "Example String",
                "canBeUnregistered": true,
                "firmwareVersion": "Example String",
                "latestFirmware": [
                  {
                    "variant": "ROUTER",
                    "version": "Example String",
                    "downloadUrl": "Example String"
                  }
                ],
                "relayConfiguration": {
                  "supportedDeviceTypes": [
                    "AIR_QUALITY_SENSOR"
                  ],
                  "endDeviceType": "AIR_QUALITY_SENSOR"
                },
                "ioModuleConfiguration": {
                  "supportedConfigurations": [
                    "BMS"
                  ],
                  "configuration": "BMS"
                },
                "area": {
                  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
                  "areaName": "Example String",
                  "areaType": "BATHROOM",
                  "size": 40,
                  "floor": 40,
                  "children": true,
                  "devices": [
                    {
                      "__typename": "Device"
                    }
                  ],
                  "accessPolicies": [
                    {
                      "__typename": "HomeProfileActionAccess"
                    }
                  ]
                },
                "traits": [
                  {
                    "traitType": "ARM_DISARM",
                    "commands": [
                      "ALARM"
                    ],
                    "attributes": [
                      {
                        "__typename": "TraitAttributeAvailableArmLevels"
                      }
                    ]
                  }
                ],
                "accessPolicy": {
                  "read": true,
                  "write": true,
                  "delete": true,
                  "expiresAt": "Example String"
                }
              }
            ],
            "accessPolicies": [
              {
                "actionType": "ALARMS_AND_NOTIFICATIONS",
                "create": true,
                "update": true,
                "delete": true,
                "read": true
              }
            ]
          }
        ],
        "notificationLifecycle": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "notifications": [
            {
              "reason": "Example String"
            }
          ]
        },
        "alarmStationNotificationLifecycle": {
          "deviceEvents": [
            {
              "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
              "events": [
                {
                  "triggeredAt": "Example String",
                  "eventType": "ACTIVATED",
                  "status": "DELIVERED"
                }
              ]
            }
          ]
        }
      }
    ]
  }
}
Next page