Abra GraphQL APIs
/Other
/- favoritesRemove
areaCreate
areaDelete
areaUpdate
areaAddHub
areaRemoveHub
cloudConnectionDisconnect
cloudConnectionElhubConnect
commandRevert
hubSetGatewayConnected
hubSetNetworkSsid
hubSetNetworkCredentials
invokeHubCommand
hubSetArmed
hubProvisioning
hubProvisioningQrGeneration
hubProvisioningRegistryUpdate
hubProvisioningAcceptance
hubProvisioningDecomission
hubProvisioningManufacturingUpdate
homeCreate
homeWithoutOwnerCreate
homeDelete
homeUpdate
homeSetInsuranceInfo
homeMemberAcceptInvitation
homeMemberRejectInvitation
homeMemberRevokeInvitation
homeMemberUpdateInvitation
homeMemberInvite
homeMemberInvitationSend
homeMemberUpdate
homeMemberUpdateRole
homeMemberDelete
hubUnregister
hubRegister
hubUpdateName
hubResolveWaterGuardTamperMode
hubResolveWaterGuardTamperWarningNotification
userMyAccountUpdate
userMyAccountUpdateLocale
userMyAccountVerifyEmail
userMyAccountResendPostRegistrationPasswordResetEmail
userInvite
userAcceptInvitation
userAccountSetRole
userDelete
commandUpdateNotification
updateNotificationCommand
hubUpdatedNotification
userMyAccountVerifyEmailNotification
userMyAccountAvatarUpdateNotification
updateNotificationUserSubscription
homeAvatarUpdateNotification
updateNotificationProject
updateNotification
updateNotificationInvitation
updateNotificationHomeMember
updateNotificationCloudConnection
updateNotificationFreezeProtection
updateNotificationRoutine
updateNotificationSmartEnergy
updateNotificationDemandResponse
updateNotificationAccount
areaSetActionAccessPolicyForUser
installerCreateProject
installerUpdateProject
installerProjectUpdateStatus
claimHome
installerDeleteProject
installerCreateHome
installerOrganizationAddInstaller
installerOrganizationRemoveInstaller
installerCreateOrganizationWithOwner
installerOrganizationCreateProject
installerOrganizationCreateProjectOnExistingHome
projectOnExistingHomeCreate
homeMemberSetEmergencyNotifications
emergencyContactDelete
emergencyContactAdd
emergencyContactUpdate
updateUserSubscriptions
userUpdatePreferences
userUpdateNotificationPreferences
updateUserMarketingPreferences
favoritesAdd
freezeProtectionConfigure
routineCreate
routineCreateInternal
routineUpdateDescription
routineActivate
routineDeactivate
routineDelete
routineUpdate
pushNotificationEndpointSet
notificationInboxMarkAsRead
demandResponseEnroll
demandResponseUnenroll
smartEnergyEnable
smartEnergyDisable
smartEnergySetHourlyLimit
housingAssociationBuildingAddFacilityTemp
housingAssociationBuildingRemoveFacilityTemp
activateGeofence
deactivateGeofence
setMOBCountdown
sendMOBEmergencyMessage
cancelMOBEmergency
favoritesRemove
Download GraphQL schema
Home
Users
Fire
Water
Access
Energy
Misc
Other
Arguments
user
I
data
Return type
Updateerrors
Mutation sample
mutation updateUserSubscriptions($userId: ID!, $data: UpdateUserSubscriptionsInput!) {
updateUserSubscriptions(userId: $userId, data: $data) {
errors {
message
path
}
}
}Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "subscriptions": [ { "subscriptionType": "ALARM_STATION", "tokens": 40 } ] } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
data
Return type
Usererrors
Mutation sample
mutation userUpdatePreferences($data: UserUpdatePreferencesInput!) {
userUpdatePreferences(data: $data) {
errors {
message
path
}
}
}Variables
{ "data": { "alarmPreferences": { "securityShowArmConfirmationModal": true }, "generalPreferences": { "betaVersion": true, "experimentalVersion": true } } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
data
Return type
Usererrors
Mutation sample
mutation userUpdateNotificationPreferences($data: NotificationPreferencesInput!) {
userUpdateNotificationPreferences(data: $data) {
errors {
message
path
}
}
}Variables
{ "data": { "notificationsEnabled": true } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
user
I
data
Return type
Updateerrors
Mutation sample
mutation updateUserMarketingPreferences($userId: ID!, $data: MarketingPreferencesInput!) {
updateUserMarketingPreferences(userId: $userId, data: $data) {
errors {
message
path
}
}
}Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "marketingConsent": true, "registrationSource": "ABRA" } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
subject
I
subject
Return type
Favoriteserrors
Mutation sample
mutation favoritesAdd($subjectId: ID!, $subjectType: FavoriteSupportedType!) {
favoritesAdd(subjectId: $subjectId, subjectType: $subjectType) {
errors {
message
path
}
}
}Variables
{ "subjectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "subjectType": "DEVICE_GROUP" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
subject
I
subject
Return type
Favoriteserrors
Mutation sample
mutation favoritesRemove($subjectId: ID!, $subjectType: FavoriteSupportedType!) {
favoritesRemove(subjectId: $subjectId, subjectType: $subjectType) {
errors {
message
path
}
}
}Variables
{ "subjectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "subjectType": "DEVICE_GROUP" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
data
Return type
Freezefreeze
errors
Mutation sample
mutation freezeProtectionConfigure($homeId: ID!, $data: FreezeProtectionConfigureInput!) {
freezeProtectionConfigure(homeId: $homeId, data: $data) {
freezeProtection {
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 {
__typename
# ...DeviceManufacturerLogoFragment
}
}
image {
url
urlSmall
urlMedium
urlLarge
}
imageWithBg {
url
urlSmall
urlMedium
urlLarge
}
instructions {
installation {
__typename
# ...DeviceInstructionItemFragment
}
configuration {
__typename
# ...DeviceInstructionItemFragment
}
help {
__typename
# ...DeviceInstructionItemFragment
}
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 {
__typename
# ...DeviceManufacturerFragment
}
deviceTemplate(
# Arguments Here
) {
__typename
# ...DeviceTemplateFragment
}
image {
__typename
# ...DeviceImageFragment
}
favorite
favoriteChangedAt
registeredAt
canBeUnregistered
firmwareVersion
latestFirmware {
__typename
# ...DeviceFirmwareFragment
}
relayConfiguration {
__typename
# ...DeviceRelayConfigurationFragment
}
ioModuleConfiguration {
__typename
# ...DeviceIoModuleConfigurationFragment
}
area {
__typename
# ...AreaFragment
}
traits {
__typename
# ...TraitFragment
}
accessPolicy {
__typename
# ...DeviceAccessPolicyFragment
}
}
accessPolicies {
actionType
create
update
delete
read
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
accessPolicy {
read
write
delete
expiresAt
}
}
activation {
triggeredAt
canSafelyOpenValve
}
}
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "enabled": true, "thresholdTemperature": 40, "temperatureSensors": [ "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" ] } }
Response sample
{ "data": { "freezeProtection": { "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": { "__typename": "DeviceManufacturerLogo" } }, "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": [ { "__typename": "DeviceInstructionItem" } ], "configuration": [ { "__typename": "DeviceInstructionItem" } ], "help": [ { "__typename": "DeviceInstructionItem" } ], "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": { "__typename": "DeviceManufacturer" }, "deviceTemplate": { "__typename": "DeviceTemplate" }, "image": { "__typename": "DeviceImage" }, "favorite": true, "favoriteChangedAt": "Example String", "registeredAt": "Example String", "canBeUnregistered": true, "firmwareVersion": "Example String", "latestFirmware": [ { "__typename": "DeviceFirmware" } ], "relayConfiguration": { "__typename": "DeviceRelayConfiguration" }, "ioModuleConfiguration": { "__typename": "DeviceIoModuleConfiguration" }, "area": { "__typename": "Area" }, "traits": [ { "__typename": "Trait" } ], "accessPolicy": { "__typename": "DeviceAccessPolicy" } } ], "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": [ { "__typename": "ArmLevel" } ] } ] } ], "accessPolicy": { "read": true, "write": true, "delete": true, "expiresAt": "Example String" } } ], "activation": { "triggeredAt": "Example String", "canSafelyOpenValve": true } }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
data
Return type
Routineroutine
I
errors
Mutation sample
mutation routineCreate($homeId: ID!, $data: RoutineCreateInput!) {
routineCreate(homeId: $homeId, data: $data) {
routineId
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "logic": { "trigger": { "triggerType": "SINGLE_CONDITION", "conditions": [ { "type": "SPECIFIC_TIME_CONDITION", "specificTimeCondition": { "at": "Example String" }, "specificTimePeriodCondition": { "startAt": "Example String", "endAt": "Example String" }, "timeOfDayPeriodCondition": { "startTime": { "__typename": "TimeOfDayInput" }, "endTime": { "__typename": "TimeOfDayInput" }, "onDays": [ "MONDAY" ] }, "timeOfDayCondition": { "atTime": { "__typename": "TimeOfDayInput" }, "onDays": [ "MONDAY" ] } } ] }, "action": { "actionType": "DEVICE_COMMAND_REVERT", "commandType": "ALARM", "commandPayload": "Example String" }, "compensatingAction": { "actionType": "DEVICE_COMMAND_REVERT", "commandType": "ALARM", "commandPayload": "Example String" } }, "description": { "name": "Example String", "description": "Example String" } } }
Response sample
{ "data": { "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
data
Return type
Routineroutine
I
errors
Mutation sample
mutation routineCreateInternal($homeId: ID!, $data: RoutineCreateInternalInput!) {
routineCreateInternal(homeId: $homeId, data: $data) {
routineId
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "logic": { "trigger": { "triggerType": "SINGLE_CONDITION", "conditions": [ { "type": "SPECIFIC_TIME_CONDITION", "specificTimeCondition": { "at": "Example String" }, "specificTimePeriodCondition": { "startAt": "Example String", "endAt": "Example String" }, "timeOfDayPeriodCondition": { "startTime": { "__typename": "TimeOfDayInput" }, "endTime": { "__typename": "TimeOfDayInput" }, "onDays": [ "MONDAY" ] }, "timeOfDayCondition": { "atTime": { "__typename": "TimeOfDayInput" }, "onDays": [ "MONDAY" ] } } ] }, "action": { "actionType": "DEVICE_COMMAND_REVERT", "commandType": "ALARM", "commandPayload": "Example String" }, "compensatingAction": { "actionType": "DEVICE_COMMAND_REVERT", "commandType": "ALARM", "commandPayload": "Example String" } }, "origin": { "type": "CUSTOM", "source": "DEMAND_RESPONSE" } } }
Response sample
{ "data": { "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
routine
I
data
Return type
Routineroutine
errors
Mutation sample
mutation routineUpdateDescription($routineId: ID!, $data: RoutineUpdateDescriptionInput!) {
routineUpdateDescription(routineId: $routineId, data: $data) {
routine {
id
logic {
trigger {
condition {
at
}
}
action {
deviceId
chargingOn
}
compensatingAction {
deviceId
chargingOn
}
}
state
origin {
type
source
}
description {
name
description
}
}
errors {
message
path
}
}
}Variables
{ "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "name": "Example String", "description": "Example String" } }
Response sample
{ "data": { "routine": { "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" } }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
routine
I
Return type
Routineerrors
Mutation sample
mutation routineActivate($routineId: ID!) {
routineActivate(routineId: $routineId) {
errors {
message
path
}
}
}Variables
{ "routineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }