Abra GraphQL APIs
/Other
/- demandResponse
area
cloudConnections
statsEnergySummary
statsTimeSeries
home
homes
homeMemberInvitations
homeMemberInvitation
homeMember
homeMembers
hubIdentifyByMacAddress
hubIdentifyBySerialNumber
hubIdentifyByQrCode
hubGetDppPayload
hubTemplates
userMyAccount
userPreferences
notificationsInbox
insuranceCompanies
userAccount
userAccountByEmail
invitedUserHome
homeOrganizations
areaAccessPoliciesForUser
areaUsersWithAccess
installerDashboard
installerProject
installerProjects
emergencyContact
emergencyContacts
command
freezeProtection
smartChargeUserSync
routines
routine
smartEnergy
housingAssociation
getGeofenceStatus
demandResponse
Download GraphQL schema
Home
Users
Fire
Water
Access
Energy
Misc
Other
Arguments
command
I
Return type
Commandid
I
home
I
command
command
triggered
String!,non-null
source
target
device
[I
Query sample
query command($commandId: ID!) {
command(commandId: $commandId) {
id
homeId
commandType
commandState
triggeredAt
source
target
deviceIds
}
}Variables
{ "commandId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "commandType": "ALARM", "commandState": "FAILED", "triggeredAt": "Example String", "source": "CUSTOMER", "target": "DEVICE", "deviceIds": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] } }
Arguments
home
I
Return type
Freezeenabled
Boolean!,non-null
threshold
Float!,non-null
temperature
activation
Query sample
query freezeProtection($homeId: ID!) {
freezeProtection(homeId: $homeId) {
enabled
thresholdTemperature
temperatureSensors {
id
deviceType
name
serialNumber
imei
macAddress
ipAddress
roomPlacement
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
deviceTemplate(
# Arguments Here
) {
id
deviceType
name
primaryPairingMode
secondaryPairingModes
manufacturer {
id
name
logo {
url
urlSmall
urlMedium
urlLarge
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
configuration {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
help {
description {
__typename
# ...DeviceInstructionDescriptionItemFragment
}
assetUrl
}
connectionAssetUrl
}
}
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
) {
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
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
id
description
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
activation {
triggeredAt
canSafelyOpenValve
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "enabled": true, "thresholdTemperature": 40, "temperatureSensors": [ { "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": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "deviceTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deviceType": "AIR_QUALITY_SENSOR", "name": "Example String", "primaryPairingMode": "PLUG", "secondaryPairingModes": [ "PLUG" ], "manufacturer": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "logo": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" } }, "image": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "imageWithBg": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String" }, "instructions": { "installation": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "configuration": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "help": [ { "description": { "__typename": "DeviceInstructionDescriptionItem" }, "assetUrl": "Example String" } ], "connectionAssetUrl": "Example String" } }, "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": [ { "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 } ] }, "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "id": 40, "description": "Example String" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "activation": { "triggeredAt": "Example String", "canSafelyOpenValve": true } } }
Return type
Smartpayload
String
Query sample
query smartChargeUserSync {
smartChargeUserSync {
payload
}
}Response sample
{ "data": { "payload": "Example String" } }
Arguments
home
I
Return type
Routineroutines
Query sample
query routines($homeId: ID!) {
routines(homeId: $homeId) {
routines {
id
logic {
trigger {
condition {
at
}
}
action {
deviceId
chargingOn
}
compensatingAction {
deviceId
chargingOn
}
}
state
origin {
type
source
}
description {
name
description
}
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "routines": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "logic": { "trigger": { "condition": { "at": "Example String" } }, "action": { "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "chargingOn": true }, "compensatingAction": { "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "chargingOn": true } }, "state": "ACTIVE", "origin": { "type": "CUSTOM", "source": "DEMAND_RESPONSE" }, "description": { "name": "Example String", "description": "Example String" } } ] } }
Arguments
routine
I
Return type
Routineid
I
logic
state
origin
description
Query sample
query routine($routineId: ID!) {
routine(routineId: $routineId) {
id
logic {
trigger {
condition {
at
}
}
action {
deviceId
chargingOn
}
compensatingAction {
deviceId
chargingOn
}
}
state
origin {
type
source
}
description {
name
description
}
}
}Variables
{ "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "logic": { "trigger": { "condition": { "at": "Example String" } }, "action": { "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "chargingOn": true }, "compensatingAction": { "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "chargingOn": true } }, "state": "ACTIVE", "origin": { "type": "CUSTOM", "source": "DEMAND_RESPONSE" }, "description": { "name": "Example String", "description": "Example String" } } }
Return type
Demandeligible
Boolean!,non-null
enrolled
Boolean!,non-null
Query sample
query demandResponse {
demandResponse {
eligible
enrolled
}
}Response sample
{ "data": { "eligible": true, "enrolled": true } }
Arguments
home
I
Return type
SmartQuery sample
query smartEnergy($homeId: ID!) {
smartEnergy(homeId: $homeId) {
enabled
configuration {
hourlyLimitWatts
}
devices {
enabled
deviceId
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "enabled": true, "configuration": { "hourlyLimitWatts": 40 }, "devices": [ { "enabled": true, "deviceId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" } ] } }
Arguments
housing
I
Return type
HousingQuery sample
query housingAssociation($housingAssociationId: ID!) {
housingAssociation(housingAssociationId: $housingAssociationId) {
id
buildings {
id
units {
id
unitNumber
}
commonAreas {
id
nickname
}
}
collectiveAlarmZones {
id
facilities {
id
units {
id
unitNumber
}
commonAreas {
id
nickname
}
}
configurations {
propagationDelaySeconds
meetingPointMap(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
}
}
}
}Variables
{ "housingAssociationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "buildings": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "units": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "unitNumber": "Example String" } ], "commonAreas": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "nickname": "Example String" } ] } ], "collectiveAlarmZones": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "facilities": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "units": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "unitNumber": "Example String" } ], "commonAreas": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "nickname": "Example String" } ] } ], "configurations": [ { "propagationDelaySeconds": 40, "meetingPointMap": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" } } ] } ] } }
Arguments
home
I
Return type
Geofenceis
Boolean!,non-null
radius
Int!,non-null
geofence
String!,non-null
Query sample
query getGeofenceStatus($homeId: ID!) {
getGeofenceStatus(homeId: $homeId) {
isActive
radius
geofenceAlarm
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "isActive": true, "radius": 40, "geofenceAlarm": "Example String" } }