Skip to content
Abra GraphQL APIs
/
/Interfaces

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

Mutations

Overview

Subscriptions

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

CloudConnectionInterface

providerId
ID!,non-null
status
CloudConnectionStatus!,non-null
connectionError
String
template
CloudConnectionTemplate!,non-null
language
Sample
{
  "providerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "status": "CONNECTED",
  "connectionError": "Example String",
  "template": {
    "__typename": "CloudConnectionTemplate"
  }
}

HomeMemberInterface

firstName
String!,non-null
lastName
String!,non-null
phoneNumber
PhoneNumber
account
HomeMemberAccount!,non-null
isEmergencyContact
Boolean
isAlarmStationContact
Boolean
Sample
{
  "firstName": "Example String",
  "lastName": "Example String",
  "phoneNumber": {
    "__typename": "PhoneNumber"
  },
  "account": {
    "__typename": "HomeMemberAccount"
  },
  "isEmergencyContact": true,
  "isAlarmStationContact": true
}

Node

id
ID!,non-null
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

TraitAttributeInterface

name
String!,non-null
dataType
TraitAttributeDataType!,non-null
editable
Boolean!,non-null
Sample
{
  "name": "Example String",
  "dataType": "ALARM_TYPE",
  "editable": true
}

AlarmInterface

id
ID!,non-null
state
AlarmState!,non-null
triggeredAt
String
snoozeExpiresAt
Stringdeprecated
Deprecation reason

not supported for some subtypes

areas
[Area!]!,non-null
notificationLifecycle
AlarmNotificationLifecycle
alarmStationNotificationLifecycle
AlarmStationNotificationLifecycle
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "state": "ALARM",
  "triggeredAt": "Example String",
  "snoozeExpiresAt": "Example String",
  "areas": [
    {
      "__typename": "Area"
    }
  ],
  "notificationLifecycle": {
    "__typename": "AlarmNotificationLifecycle"
  },
  "alarmStationNotificationLifecycle": {
    "__typename": "AlarmStationNotificationLifecycle"
  }
}

CollectiveAlarmInterface

id
ID!,non-null
state
CollectiveAlarmState!,non-null
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "state": "ALARM"
}

PayloadError

message
String!,non-null
path
String!,non-null
Sample
{
  "message": "Example String",
  "path": "Example String"
}
Referenced in
AreaSetActionAccessPolicyForUserPayload.errors

UpdatePayloadInterface

partyId
ID
homeId
ID!,non-null
action
UpdatedAction
Sample
{
  "partyId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "action": "ADDED"
}

ProjectInterface

id
ID!,non-null
installerId
ID
status
ProjectStatus!,non-null
avatar
ImageInfo
uploadFile
Sample
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "installerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "status": "FINISHED",
  "avatar": {
    "__typename": "ImageInfo"
  }
}

Unions

Overview

Enums

Overview

Inputs

Overview