Abra GraphQL APIs
/Other
/- installerProject
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
installerProjects
emergencyContact
emergencyContacts
command
freezeProtection
smartChargeUserSync
routines
routine
demandResponse
smartEnergy
housingAssociation
getGeofenceStatus
installerProject
Download GraphQL schema
Home
Users
Fire
Water
Access
Energy
Misc
Other
Arguments
home Id
I D!,non-nullrequired
Return type
InvitedQuery sample
query invitedUserHome($homeId: ID!) {
invitedUserHome(homeId: $homeId) {
id
name
type
locationInfo {
country
city
postalCode
street
streetNumber
unitNumber
geoLocation {
latitude
longitude
}
apartmentNumber
associationId
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "type": "APARTMENT", "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" } } }
Arguments
home Id
I D!,non-nullrequired
Return type
[Organization!]!id
I D!,non-null
name
String!,non-null
address
String!,non-null
email
String!,non-null
phone Numbers
Query sample
query homeOrganizations($homeId: ID!) {
homeOrganizations(homeId: $homeId) {
id
name
address
email
phoneNumbers {
countryCode
nationalNumber
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "address": "Example String", "email": "Example String", "phoneNumbers": [ { "countryCode": "Example String", "nationalNumber": "Example String" } ] } ] }
Arguments
area Id
I D!,non-nullrequired
user Id
I D!,non-nullrequired
Return type
[Homeaction Type
create
Boolean!,non-null
update
Boolean!,non-null
delete
Boolean!,non-null
read
Boolean!,non-null
Query sample
query areaAccessPoliciesForUser($areaId: ID!, $userId: ID!) {
areaAccessPoliciesForUser(areaId: $areaId, userId: $userId) {
actionType
create
update
delete
read
}
}Variables
{ "areaId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": [ { "actionType": "ALARMS_AND_NOTIFICATIONS", "create": true, "update": true, "delete": true, "read": true } ] }
Arguments
area Id
I D!,non-nullrequired
Return type
[HomeQuery sample
query areaUsersWithAccess($areaId: ID!) {
areaUsersWithAccess(areaId: $areaId) {
id
firstName
lastName
phoneNumber {
countryCode
nationalNumber
}
account {
id
email
avatar {
url
urlSmall
urlMedium
urlLarge
uploadUrl
}
}
isEmergencyContact
isAlarmStationContact
}
}Variables
{ "areaId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "account": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" } }, "isEmergencyContact": true, "isAlarmStationContact": true } ] }
Return type
Installerprojects
organization
Query sample
query installerDashboard {
installerDashboard {
projects {
installerProjects {
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
}
}
}
organization {
organization {
id
name
projects {
installerProjects {
id
installerId
status
avatar(
# Arguments Here
) {
__typename
# ...ImageInfoFragment
}
buildingType
buildingYear
buildingSize
locationInfo {
__typename
# ...HomeLocationInfoFragment
}
constructionType
description {
__typename
# ...ProjectDescriptionFragment
}
hubs {
__typename
# ...TransferredProjectHubFragment
}
devices {
__typename
# ...TransferredProjectDeviceFragment
}
}
}
members {
id
account {
id
email
emailVerified
phoneNumber {
__typename
# ...PhoneNumberFragment
}
firstName
lastName
avatar {
__typename
# ...AvatarFragment
}
avatarV2(
# Arguments Here
) {
__typename
# ...ImageInfoFragment
}
roles
}
role
}
}
role
}
}
}Response sample
{ "data": { "projects": { "installerProjects": [ { "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" } ] } ] }, "organization": { "organization": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "projects": { "installerProjects": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "installerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "status": "FINISHED", "avatar": { "__typename": "ImageInfo" }, "buildingType": "APARTMENT", "buildingYear": 40, "buildingSize": 40, "locationInfo": { "__typename": "HomeLocationInfo" }, "constructionType": "CONCRETE", "description": { "__typename": "ProjectDescription" }, "hubs": [ { "__typename": "TransferredProjectHub" } ], "devices": [ { "__typename": "TransferredProjectDevice" } ] } ] }, "members": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "account": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "emailVerified": true, "phoneNumber": { "__typename": "PhoneNumber" }, "firstName": "Example String", "lastName": "Example String", "avatar": { "__typename": "Avatar" }, "avatarV2": { "__typename": "ImageInfo" }, "roles": [ "INSTALLER" ] }, "role": "INSTALLER" } ] }, "role": "INSTALLER" } } }
Arguments
project Id
I D!,non-nullrequired
Return type
ProjectQuery sample
query installerProject($projectId: ID!) {
installerProject(projectId: $projectId) {
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
}
}
}Variables
{ "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "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" } ] } }
Return type
Installerinstaller Projects
Query sample
query installerProjects {
installerProjects {
installerProjects {
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
}
}
}
}Response sample
{ "data": { "installerProjects": [ { "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" } ] } ] } }
Arguments
emergency Contact Id
I D!,non-nullrequired
Return type
Emergencyid
I D!,non-null
first Name
String!,non-null
last Name
String!,non-null
phone Number
is Alarm Station Contact
Boolean
Query sample
query emergencyContact($emergencyContactId: ID!) {
emergencyContact(emergencyContactId: $emergencyContactId) {
id
firstName
lastName
phoneNumber {
countryCode
nationalNumber
}
isAlarmStationContact
}
}Variables
{ "emergencyContactId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "isAlarmStationContact": true } }
Arguments
home Id
I D!,non-nullrequired
Return type
Emergencyemergency Contacts
Query sample
query emergencyContacts($homeId: ID!) {
emergencyContacts(homeId: $homeId) {
emergencyContacts {
id
firstName
lastName
phoneNumber {
countryCode
nationalNumber
}
isAlarmStationContact
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "emergencyContacts": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "isAlarmStationContact": true } ] } }
Arguments
command Id
I D!,non-nullrequired
Return type
Commandid
I D!,non-null
home Id
I D!,non-null
command Type
command State
triggered At
String!,non-null
source
target
device Ids
[I D!],non-null
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 Id
I D!,non-nullrequired
Return type
Freezeenabled
Boolean!,non-null
threshold Temperature
Float!,non-null
temperature Sensors
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 } } }