properties

The properties attached to the given account.

This field requires the Authorization header to be set.

Arguments

accountNumber : String!


            required

active : Boolean

Returns

[PropertyType]

Represents a property. Conceptually, it collects supply points under an address.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can book smart meter appointments
OR Can display siteworks appointments
OR Can query property
OR Can query property meters
OR Can submit meter readings

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 Properties(
  $accountNumber: String!,
  $active: Boolean
) {
  properties(
    accountNumber: $accountNumber,
    active: $active
  ) {
    address
    ancestors {
      ...PropertyConnectionFragment
    }
    availableSmets2InstallationTimeslots {
      ...Smets2InstallationTimeslotTypeFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    descendants {
      ...PropertyConnectionFragment
    }
    electricityMeterPoints {
      ...ElectricityMeterPointTypeFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    gasMeterPoints {
      ...GasMeterPointTypeFragment
    }
    id
    isChangeOfTenancyOngoing
    isSmets2InstallationAllowed
    label
    measurements {
      ...MeasurementConnectionFragment
    }
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    parent {
      ...PropertyInterfaceFragment
    }
    postcode
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    smartDeviceNetworks {
      ...SmartMeterDeviceNetworkTypeFragment
    }
    splitAddress
    wanCoverage
  }
}

{
  "accountNumber": "A-5CC4B38D",
  "active": true
}

{
  "data": {
    "properties": [
      {
        "address": "type-meeting-hospital-time-loss",
        "ancestors": PropertyConnection,
        "availableSmets2InstallationTimeslots": [Smets2InstallationTimeslotType],
        "coordinates": CoordinatesType,
        "descendants": PropertyConnection,
        "electricityMeterPoints": [ElectricityMeterPointType],
        "embeddedNetwork": EmbeddedNetworkType,
        "gasMeterPoints": [GasMeterPointType],
        "id": "27411191",
        "isChangeOfTenancyOngoing": true,
        "isSmets2InstallationAllowed": true,
        "label": "present-large-write-rest-strong",
        "measurements": MeasurementConnection,
        "occupancyPeriods": [OccupancyPeriodType],
        "parent": PropertyInterface,
        "postcode": "red-movie-to-story-fact",
        "richAddress": PropertyRichAddressType,
        "smartDeviceNetworks": [SmartMeterDeviceNetworkType],
        "splitAddress": "church-have-minute-best-generation",
        "wanCoverage": "HIGH"
      }
    ]
  }
}