Skip to content
Home
Overview
Overview
Users
Overview
Overview
Fire
Overview
Overview
Water
Overview
Overview
Access
Overview
Overview
Energy
Overview
Overview
Misc
Overview
Overview
Other
Overview
Overview
Overview
Overview
id
ID!,non-null
name
String
hubType
productType
brandName
String
firmwareVersion
String
serialNumber
String
macAddress
String!,non-null
manufacturerInformation
String
wasWaterSensorTapePreviouslyConnected
Boolean!,non-nulldeprecated
Deprecation reason

use waterGuard

waterGuard
hubTemplate
HubTemplate!,non-null
area
devices
[Device!]!,non-null
sortfilter
repeaters
[Hub!]!,non-null
traits
[Trait!]!,non-null
Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubType": "GATEWAY", "productType": "HUB_4G", "brandName": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "macAddress": "Example String", "manufacturerInformation": "Example String", "wasWaterSensorTapePreviouslyConnected": true, "waterGuard": { "__typename": "HubWaterGuard" }, "hubTemplate": { "__typename": "HubTemplate" }, "area": { "__typename": "Area" }, "devices": [ { "__typename": "Device" } ], "repeaters": [ { "__typename": "Hub" } ], "traits": [ { "__typename": "Trait" } ] }
id
ID!,non-null
firmwareVersion
String
serialNumber
String!,non-null
registered
Boolean!,non-null
homeToClaim
ID
homeId
IDdeprecated
Deprecation reason

use homeToClaim

Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firmwareVersion": "Example String", "serialNumber": "Example String", "registered": true, "homeToClaim": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
id
ID!,non-null
macAddress
String!,non-null
firmwareVersion
String
serialNumber
String!,non-null
registered
Boolean!,non-null
Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "macAddress": "Example String", "firmwareVersion": "Example String", "serialNumber": "Example String", "registered": true }
kind
source
Sample
{ "kind": "UNSPECIFIED", "source": "UNSPECIFIED" }
title
String!,non-null
body
String!,non-null
Sample
{ "title": "Example String", "body": "Example String" }
id
ID!,non-null
message
deepLink
String
receivedAt
String!,non-null
read
Boolean!,non-null
context
Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "message": { "__typename": "NotificationMessage" }, "deepLink": "Example String", "receivedAt": "Example String", "read": true, "context": { "__typename": "NotificationContext" } }
notifications
Sample
{ "notifications": [ { "__typename": "InboxNotification" } ] }
consumptionUnit
EnergyUnit!,non-null
mostEfficientConsumption
Float!,non-null
averageConsumption
Float!,non-null
leastEfficientConsumption
Float!,non-null
actualConsumption
Float!,non-null
actualVsAverageConsumptionComparison
actualVsAverageConsumptionPercent
Float!,non-null
Sample
{ "consumptionUnit": "KILOWATT_HOUR", "mostEfficientConsumption": 40, "averageConsumption": 40, "leastEfficientConsumption": 40, "actualConsumption": 40, "actualVsAverageConsumptionComparison": "LESS_THAN_AVERAGE", "actualVsAverageConsumptionPercent": 40 }
relativeConsumption
Sample
{ "relativeConsumption": { "__typename": "EnergyRelativeConsumption" }, "errors": [ { "__typename": "DataNotAvailableError" } ] }

PushNotificationEndpointSetPayload

Sample
{ "errors": [ { "__typename": "UnableToSetPushNotificationEndpointError" } ] }

NotificationInboxMarkAsReadPayload

Sample
{ "errors": [ { "__typename": "NotificationDoesNotExistError" } ] }
Overview
Overview
Overview
Overview