Skip to content
Abra GraphQL APIs
/
Other
/
/
invitedUserHome

GraphQL Overview

Download GraphQL schema
schema.graphql
Home

Queries

Overview

Mutations

Overview
Users

Queries

Overview

Mutations

Overview
Fire

Queries

Overview

Mutations

Overview
Water

Queries

Overview

Mutations

Overview
Access

Queries

Overview

Mutations

Overview
Energy

Queries

Overview

Mutations

Overview
Misc

Queries

Overview

Mutations

Overview
Other

Queries

Overview

userPreferences

AccountPreferences

Return type

AccountPreferences
alarmPreferences
AlarmPreferences!,non-null
notificationPreferences
NotificationPreferences!,non-null
generalPreferences
GeneralPreferences!,non-null
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
    }
  }
}

notificationsInbox

InboxNotificationCollection

Return type

InboxNotificationCollection
notifications
[InboxNotification!]!,non-null
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"
        }
      }
    ]
  }
}

insuranceCompanies

(homeId)
InsuranceCompanyCollection

Arguments

homeId
ID!,non-nullrequired

Return type

InsuranceCompanyCollection
insuranceCompanies
[InsuranceCompany!]!,non-null
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"
      }
    ]
  }
}

userAccount

(userId)
Account

Arguments

userId
ID!,non-nullrequired

Return type

Account
id
ID!,non-null
email
String!,non-null
emailVerified
Boolean!,non-null
phoneNumber
PhoneNumber
firstName
String
lastName
String
avatar
Avatardeprecated
Deprecation reason

use avatarV2

avatarV2
ImageInfo
uploadFile
roles
[Role!]!,non-null
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"
    ]
  }
}

userAccountByEmail

(email)
Account

Arguments

email
String!,non-nullrequired

Return type

Account
id
ID!,non-null
email
String!,non-null
emailVerified
Boolean!,non-null
phoneNumber
PhoneNumber
firstName
String
lastName
String
avatar
Avatardeprecated
Deprecation reason

use avatarV2

avatarV2
ImageInfo
uploadFile
roles
[Role!]!,non-null
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"
    ]
  }
}

invitedUserHome

(homeId)
InvitedUserHome

Arguments

homeId
ID!,non-nullrequired

Return type

InvitedUserHome
id
ID!,non-null
name
String
type
HomeType
locationInfo
HomeLocationInfo
Query 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"
    }
  }
}

homeOrganizations

(homeId)
[Organization!]!,non-null

Arguments

homeId
ID!,non-nullrequired

Return type

[Organization!]!
id
ID!,non-null
name
String!,non-null
address
String!,non-null
email
String!,non-null
phoneNumbers
[PhoneNumber]!,non-null
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"
        }
      ]
    }
  ]
}

areaAccessPoliciesForUser

(...args)
[HomeProfileActionAccess!]!,non-null

Arguments

areaId
ID!,non-nullrequired
userId
ID!,non-nullrequired

Return type

[HomeProfileActionAccess!]!
actionType
HomeProfileActionType!,non-null
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
    }
  ]
}

areaUsersWithAccess

(areaId)
[HomeMember!]!,non-null

Arguments

areaId
ID!,non-nullrequired

Return type

[HomeMember!]!
HomeOwner
HomeAdministrator
HomeUser
HomeChild
HomeGuest
Query 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
    }
  ]
}

installerDashboard

InstallerDashboard

Return type

InstallerDashboard
projects
InstallerProjectCollection
organization
InstallerOrganizationDashboard
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"
    }
  }
}

installerProject

(projectId)
Project

Arguments

projectId
ID!,non-nullrequired

Return type

Project
TransferredProject
OngoingProject
Query 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"
      }
    ]
  }
}

Mutations

Overview

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview