devices

A list of devices registered to an account.

Arguments

accountNumber : String!


            required

The account number, e.g. A-12345678.

deviceId : String

Only list the device with this ID.

integrationDeviceId : String

Only list the device with this integration device ID.

propertyId : ID

Only list devices registered to this property.

Returns

[SmartFlexDeviceInterface!]

Some general information about a device.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries
OR Can query devices

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query Devices(
  $accountNumber: String!,
  $deviceId: String,
  $integrationDeviceId: String,
  $propertyId: ID
) {
  devices(
    accountNumber: $accountNumber,
    deviceId: $deviceId,
    integrationDeviceId: $integrationDeviceId,
    propertyId: $propertyId
  ) {
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    deviceType
    id
    integrationDeviceId
    name
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
    preferenceSetting {
      ...FlexDevicePreferenceSettingInterfaceFragment
    }
    propertyId
    provider
    reAuthenticationState {
      ...DeviceReAuthenticationInterfaceFragment
    }
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
  }
}

{
  "accountNumber": "A-57F10038",
  "deviceId": "96609146",
  "integrationDeviceId": "59484750",
  "propertyId": "31403396"
}

{
  "data": {
    "devices": [
      {
        "alerts": SmartFlexDeviceAlertInterface,
        "deviceType": "BATTERIES",
        "id": "78670059",
        "integrationDeviceId": "37359509",
        "name": "find-realize-support-he-red",
        "onboardingWizard": SmartFlexOnboardingWizard,
        "preferences": SmartFlexDevicePreferencesInterface,
        "preferenceSetting": FlexDevicePreferenceSettingInterface,
        "propertyId": "72381495",
        "provider": "BMW",
        "reAuthenticationState": DeviceReAuthenticationInterface,
        "status": SmartFlexDeviceStatusInterface
      }
    ]
  }
}