Abra GraphQL APIs
/Other
/- userAccountByEmail
area
cloudConnections
statsEnergySummary
statsTimeSeries
home
homes
homeMemberInvitations
homeMemberInvitation
homeMember
homeMembers
hubIdentifyByMacAddress
hubIdentifyBySerialNumber
hubIdentifyByQrCode
hubGetDppPayload
hubTemplates
userMyAccount
userPreferences
notificationsInbox
insuranceCompanies
userAccount
invitedUserHome
homeOrganizations
areaAccessPoliciesForUser
areaUsersWithAccess
installerDashboard
installerProject
installerProjects
emergencyContact
emergencyContacts
command
freezeProtection
smartChargeUserSync
routines
routine
demandResponse
smartEnergy
housingAssociation
getGeofenceStatus
userAccountByEmail
Download GraphQL schema
Home
Users
Fire
Water
Access
Energy
Misc
Other
Return type
Accountid
I
email
String!,non-null
email
Boolean!,non-null
phone
first
String
last
String
avatar
Avatardeprecated
Deprecation reason
use avatarV2
avatar
uploadFile
roles
Query sample
query userMyAccount {
userMyAccount {
id
email
emailVerified
phoneNumber {
countryCode
nationalNumber
}
firstName
lastName
avatar {
url
urlSmall
urlMedium
urlLarge
uploadUrl
}
avatarV2(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
roles
}
}Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "emailVerified": true, "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "firstName": "Example String", "lastName": "Example String", "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" }, "avatarV2": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" }, "roles": [ "INSTALLER" ] } }
Return type
Accountalarm
notification
general
Query sample
query userPreferences {
userPreferences {
alarmPreferences {
securityShowArmConfirmationModal
}
notificationPreferences {
notificationsEnabled
}
generalPreferences {
betaVersion
experimentalVersion
}
}
}Response sample
{ "data": { "alarmPreferences": { "securityShowArmConfirmationModal": true }, "notificationPreferences": { "notificationsEnabled": true }, "generalPreferences": { "betaVersion": true, "experimentalVersion": true } } }
Return type
Inboxnotifications
Query sample
query notificationsInbox {
notificationsInbox {
notifications {
id
message {
title
body
}
deepLink
receivedAt
read
context {
kind
source
}
}
}
}Response sample
{ "data": { "notifications": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "message": { "title": "Example String", "body": "Example String" }, "deepLink": "Example String", "receivedAt": "Example String", "read": true, "context": { "kind": "UNSPECIFIED", "source": "UNSPECIFIED" } } ] } }
Arguments
home
I
Return type
Insuranceinsurance
Query sample
query insuranceCompanies($homeId: ID!) {
insuranceCompanies(homeId: $homeId) {
insuranceCompanies {
id
name
}
}
}Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "insuranceCompanies": [ { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String" } ] } }
Arguments
user
I
Return type
Accountid
I
email
String!,non-null
email
Boolean!,non-null
phone
first
String
last
String
avatar
Avatardeprecated
Deprecation reason
use avatarV2
avatar
uploadFile
roles
Query sample
query userAccount($userId: ID!) {
userAccount(userId: $userId) {
id
email
emailVerified
phoneNumber {
countryCode
nationalNumber
}
firstName
lastName
avatar {
url
urlSmall
urlMedium
urlLarge
uploadUrl
}
avatarV2(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
roles
}
}Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "emailVerified": true, "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "firstName": "Example String", "lastName": "Example String", "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" }, "avatarV2": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" }, "roles": [ "INSTALLER" ] } }
Arguments
email
String!,non-nullrequired
Return type
Accountid
I
email
String!,non-null
email
Boolean!,non-null
phone
first
String
last
String
avatar
Avatardeprecated
Deprecation reason
use avatarV2
avatar
uploadFile
roles
Query sample
query userAccountByEmail($email: String!) {
userAccountByEmail(email: $email) {
id
email
emailVerified
phoneNumber {
countryCode
nationalNumber
}
firstName
lastName
avatar {
url
urlSmall
urlMedium
urlLarge
uploadUrl
}
avatarV2(
# Arguments Here
) {
url {
original
small
medium
large
}
uploadUrl
}
roles
}
}Variables
{ "email": "Example String" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "email": "Example String", "emailVerified": true, "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "firstName": "Example String", "lastName": "Example String", "avatar": { "url": "Example String", "urlSmall": "Example String", "urlMedium": "Example String", "urlLarge": "Example String", "uploadUrl": "Example String" }, "avatarV2": { "url": { "original": "Example String", "small": "Example String", "medium": "Example String", "large": "Example String" }, "uploadUrl": "Example String" }, "roles": [ "INSTALLER" ] } }
Arguments
home
I
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
I
Return type
[Organization!]!id
I
name
String!,non-null
address
String!,non-null
email
String!,non-null
phone
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
I
user
I
Return type
[Homeaction
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
I
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" } } }