Skip to main content

Implemented by

Fields

address : String

The address of the property, formatted into a single string.

ancestors : PropertyConnection

Ancestor properties in the specified hierarchy, ordered from root to immediate parent. Returns empty list if the property is not in the hierarchy.

Arguments
after : String
before : String
first : Int
hierarchyName : String default: default

The name of the hierarchy to query within.

last : Int
coordinates : CoordinatesType

Coordinates for the property, useful for displaying the property on a map.

descendants : PropertyConnection

Descendant properties in the specified hierarchy. Returns empty list if the property is not in the hierarchy.

Arguments
after : String
before : String
depth : Int default: 1

Maximum depth of descendants to return. Defaults to 1 (immediate children). Set to null for all descendants.

first : Int
hierarchyName : String default: default

The name of the hierarchy to query within.

last : Int
embeddedNetwork : EmbeddedNetworkType

The embedded network this property belongs to, if any.

id : String
label : String

An optional label for the property.

measurements : MeasurementConnection

Measurements at a property

Arguments
after : String
before : String
endAt : DateTime default: 9999-12-29T23:59:59.999999+00:00

Defaults to the far future which will return the most recent readings.

endOn : Date

Latest date to return measurements for (inclusive).

first : Int
last : Int
startAt : DateTime default: 0001-01-03T00:00:00-00:01:15

Defaults to the far past which will return the oldest readings.

startOn : Date

Earliest date to return measurements from.

timezone : String default: Europe/London

Timezone to use for grouping. Defaults to Kraken localtime.

utilityFilters : [UtilityFiltersInput]

Filters for each utility being measured.

occupancyPeriods : [OccupancyPeriodType]

Time periods during which the property is associated with an account. Useful to display information about house-moves, as performing a move out of a property will set the end date for the occupancy period.

The parent property in the specified hierarchy. Returns null if the property has no parent or is not in the hierarchy.

Arguments
hierarchyName : String default: default

The name of the hierarchy to query within.

richAddress : PropertyRichAddressType

Property rich address.

splitAddress : [String]

List of address lines.

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.

Example

{ "address": "choose-interview-walk-rest-site", "ancestors": PropertyConnection, "coordinates": CoordinatesType, "descendants": PropertyConnection, "embeddedNetwork": EmbeddedNetworkType, "id": "76441242", "label": "race-response-girl-middle-close", "measurements": MeasurementConnection, "occupancyPeriods": [OccupancyPeriodType], "parent": PropertyInterface, "richAddress": PropertyRichAddressType, "splitAddress": "role-American-wonder-space-pick" }