Abra GraphQL APIs
/Other
/- claimHome
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
installerDeleteProject
installerCreateHome
installerOrganizationAddInstaller
installerOrganizationRemoveInstaller
installerCreateOrganizationWithOwner
installerOrganizationCreateProject
installerOrganizationCreateProjectOnExistingHome
projectOnExistingHomeCreate
homeMemberSetEmergencyNotifications
emergencyContactDelete
emergencyContactAdd
emergencyContactUpdate
updateUserSubscriptions
userUpdatePreferences
userUpdateNotificationPreferences
updateUserMarketingPreferences
favoritesAdd
favoritesRemove
freezeProtectionConfigure
routineCreate
routineCreateInternal
routineUpdateDescription
routineActivate
routineDeactivate
routineDelete
routineUpdate
pushNotificationEndpointSet
notificationInboxMarkAsRead
demandResponseEnroll
demandResponseUnenroll
smartEnergyEnable
smartEnergyDisable
smartEnergySetHourlyLimit
housingAssociationBuildingAddFacilityTemp
housingAssociationBuildingRemoveFacilityTemp
activateGeofence
deactivateGeofence
setMOBCountdown
sendMOBEmergencyMessage
cancelMOBEmergency
claimHome
Download GraphQL schema
Home
Users
Fire
Water
Access
Energy
Misc
Other
Arguments
user
I
action
Return type
UserMutation sample
mutation updateNotificationAccount($userId: ID!, $action: UpdatedAction!) {
updateNotificationAccount(userId: $userId, action: $action) {
userId
action
demandResponse {
eligible
enrolled
}
}
}Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "action": "ADDED" }
Response sample
{ "data": { "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "action": "ADDED", "demandResponse": { "eligible": true, "enrolled": true } } }
Arguments
area
I
user
I
access
Return type
Areaaction
errors
Mutation sample
mutation areaSetActionAccessPolicyForUser(
$areaId: ID!
$userId: ID!
$accessInput: ChangeActionAccessesInput!
) {
areaSetActionAccessPolicyForUser(
areaId: $areaId
userId: $userId
accessInput: $accessInput
) {
actionAccesses {
actionType
create
update
delete
read
}
errors {
message
path
}
}
}Variables
{ "areaId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "accessInput": { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } }
Response sample
{ "data": { "actionAccesses": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ], "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
data
Return type
ProjectMutation sample
mutation installerCreateProject($data: ProjectCreateInput!) {
installerCreateProject(data: $data) {
projectId
homeId
errors {
message
path
}
}
}Variables
{ "data": { "location": { "country": "Example String", "city": "Example String", "street": "Example String", "postalCode": "Example String", "streetNumber": "Example String", "unitNumber": "Example String", "geoLocation": { "latitude": 40, "longitude": 40 }, "apartmentNumber": "Example String", "associationPk": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }, "buildingType": "APARTMENT", "constructionType": "CONCRETE", "buildingYear": 40, "projectNumber": "Example String", "sizeOfHousehold": 40, "buildingTitle": "Example String", "orderReferenceNumber": "Example String" } }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
project
I
data
Return type
Projectproject
errors
Mutation sample
mutation installerUpdateProject($projectId: ID!, $data: ProjectUpdateInput!) {
installerUpdateProject(projectId: $projectId, data: $data) {
project {
id
installerId
status
avatar(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
buildingType
buildingYear
buildingSize
locationInfo {
country
city
postalCode
street
streetNumber
unitNumber
geoLocation {
latitude
longitude
}
apartmentNumber
associationId
}
constructionType
description {
projectNumber
orderReferenceNumber
buildingTitle
}
hubs {
area {
areaName
areaType
}
}
devices {
area {
areaName
areaType
}
deviceType
}
}
errors {
message
path
}
}
}Variables
{ "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "projectNumber": "Example String", "orderReferenceNumber": "Example String", "buildingTitle": "Example String" } }
Response sample
{ "data": { "project": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "installerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "status": "FINISHED", "avatar": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" }, "buildingType": "APARTMENT", "buildingYear": 40, "buildingSize": 40, "locationInfo": { "country": "Example String", "city": "Example String", "postalCode": "Example String", "street": "Example String", "streetNumber": "Example String", "unitNumber": "Example String", "geoLocation": { "latitude": 40, "longitude": 40 }, "apartmentNumber": "Example String", "associationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }, "constructionType": "CONCRETE", "description": { "projectNumber": "Example String", "orderReferenceNumber": "Example String", "buildingTitle": "Example String" }, "hubs": [ { "area": { "areaName": "Example String", "areaType": "BATHROOM" } } ], "devices": [ { "area": { "areaName": "Example String", "areaType": "BATHROOM" }, "deviceType": "AIR_QUALITY_SENSOR" } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
project
I
status
Return type
Installererrors
Mutation sample
mutation installerProjectUpdateStatus($projectId: ID!, $status: ProjectStatus!) {
installerProjectUpdateStatus(projectId: $projectId, status: $status) {
errors {
message
path
}
}
}Variables
{ "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "status": "FINISHED" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
Return type
Claimerrors
Mutation sample
mutation claimHome($homeId: ID!) {
claimHome(homeId: $homeId) {
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
project
I
Return type
Projectproject
I
errors
Mutation sample
mutation installerDeleteProject($projectId: ID!) {
installerDeleteProject(projectId: $projectId) {
projectId
errors {
message
path
}
}
}Variables
{ "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
home
I
Return type
Homehome
errors
Mutation sample
mutation installerCreateHome($homeId: ID!) {
installerCreateHome(homeId: $homeId) {
home {
id
locationInfo {
country
city
postalCode
street
streetNumber
unitNumber
geoLocation {
latitude
longitude
}
apartmentNumber
associationId
}
systemCountry
homeInfo {
nickname
avatarUrl
size
ageOfBuilding
numberOfFloors
numberOfAdults
numberOfChildren
homeType
dwellingUnit
heatingType
cooling
ventilation
propertyManagerName
constructionType
buildingYear
}
avatar(
# Arguments Here
) {
url
urlSmall
urlMedium
urlLarge
uploadUrl
}
insuranceInfo {
insuranceCompany {
id
name
}
}
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
}
}
devices(
# Arguments Here
) {
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
}
}
hubs {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
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
}
}
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
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
wasWaterSensorTapePreviouslyConnected
mode
tamperModeWarningTriggeredAt
tamperModeTriggersAt
overrideModeTriggeredAt
showLevel1Warning
showLevel2Warning
}
hubTemplate {
id
name
hubAssetUrl
hubWithBgAssetUrl
hubQrCodeAssetUrl
hubConnectionAssetUrl
hubSearchAssetUrl
waterLeakDetectorAssetUrl
waterLeakDetectorInstructionsAssetUrl
waterLeakDetectorHelpAssetUrl
waterSensorTapeAssetUrl
waterSensorTapeInstructionsAssetUrl
waterLeakSystemPressHubButtonAssetUrl
sintefLogoAssetUrl
}
area {
id
areaName
areaType
size
floor
children
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
accessPolicies {
__typename
# ...HomeProfileActionAccessFragment
}
}
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
}
}
repeaters {
id
name
hubType
productType
brandName
firmwareVersion
serialNumber
macAddress
manufacturerInformation
wasWaterSensorTapePreviouslyConnected
waterGuard {
__typename
# ...HubWaterGuardFragment
}
hubTemplate {
__typename
# ...HubTemplateFragment
}
area {
__typename
# ...AreaFragment
}
devices(
# Arguments Here
) {
__typename
# ...DeviceFragment
}
repeaters {
__typename
# ...HubFragment
}
traits {
__typename
# ...TraitFragment
}
}
traits {
traitType
commands
attributes {
__typename
# ...TraitAttributeAvailableArmLevelsFragment
}
}
}
traits {
traitType
commands
attributes {
name
dataType
editable
availableArmLevels {
__typename
# ...ArmLevelFragment
}
}
}
}
}
errors {
message
path
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "home": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "locationInfo": { "country": "Example String", "city": "Example String", "postalCode": "Example String", "street": "Example String", "streetNumber": "Example String", "unitNumber": "Example String", "geoLocation": { "latitude": 40, "longitude": 40 }, "apartmentNumber": "Example String", "associationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }, "systemCountry": "NO", "homeInfo": { "nickname": "Example String", "avatarUrl": "Example String", "size": 40, "ageOfBuilding": 40, "numberOfFloors": 40, "numberOfAdults": 40, "numberOfChildren": 40, "homeType": "APARTMENT", "dwellingUnit": "SDU", "heatingType": "AIR_TO_AIR_HEATPUMP", "cooling": "AC", "ventilation": true, "propertyManagerName": "Example String", "constructionType": "CONCRETE", "buildingYear": 40 }, "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" }, "insuranceInfo": { "insuranceCompany": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "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 } ] } ], "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": { "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" } } ], "hubs": [ { "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": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "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 } ] }, "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" } } ], "repeaters": [ { "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": { "wasWaterSensorTapePreviouslyConnected": true, "mode": "NORMAL", "tamperModeWarningTriggeredAt": "Example String", "tamperModeTriggersAt": "Example String", "overrideModeTriggeredAt": "Example String", "showLevel1Warning": true, "showLevel2Warning": true }, "hubTemplate": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "hubAssetUrl": "Example String", "hubWithBgAssetUrl": "Example String", "hubQrCodeAssetUrl": "Example String", "hubConnectionAssetUrl": "Example String", "hubSearchAssetUrl": "Example String", "waterLeakDetectorAssetUrl": "Example String", "waterLeakDetectorInstructionsAssetUrl": "Example String", "waterLeakDetectorHelpAssetUrl": "Example String", "waterSensorTapeAssetUrl": "Example String", "waterSensorTapeInstructionsAssetUrl": "Example String", "waterLeakSystemPressHubButtonAssetUrl": "Example String", "sintefLogoAssetUrl": "Example String" }, "area": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "areaName": "Example String", "areaType": "BATHROOM", "size": 40, "floor": 40, "children": true, "devices": [ { "__typename": "Device" } ], "accessPolicies": [ { "__typename": "HomeProfileActionAccess" } ] }, "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" } } ], "repeaters": [ { "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" } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "__typename": "TraitAttributeAvailableArmLevels" } ] } ] } ], "traits": [ { "traitType": "ARM_DISARM", "commands": [ "ALARM" ], "attributes": [ { "name": "Example String", "dataType": "ALARM_TYPE", "editable": true, "availableArmLevels": [ { "__typename": "ArmLevel" } ] } ] } ] } ] }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
organization
I
email
String!,non-nullrequired
Return type
Installererrors
Mutation sample
mutation installerOrganizationAddInstaller($organizationId: ID!, $email: String!) {
installerOrganizationAddInstaller(organizationId: $organizationId, email: $email) {
errors {
message
path
}
}
}Variables
{ "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
user
I
organization
I
Return type
Installererrors
Mutation sample
mutation installerOrganizationRemoveInstaller($userId: ID!, $organizationId: ID!) {
installerOrganizationRemoveInstaller(userId: $userId, organizationId: $organizationId) {
errors {
message
path
}
}
}Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Arguments
data
Return type
Installerorganization
I
errors
Mutation sample
mutation installerCreateOrganizationWithOwner($data: InstallerCreateOrganizationWithOwnerInput!) {
installerCreateOrganizationWithOwner(data: $data) {
organizationId
errors {
message
path
}
}
}Variables
{ "data": { "organizationName": "Example String", "ownerEmail": "Example String" } }
Response sample
{ "data": { "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }