Spaces

Retrieve metadata and environmental/utility metrics (real-time and aggregated) for a Space or Cluster.

📄️ Get all Spaces

Returns a list of all Spaces with their basic metadata and identifiers.<br/><br/>Spaces that belong to a Cluster will have both `ClusterUuid` and `ClusterName` populated. Standalone Spaces (e.g. Studios, etc) will have those fields set to `null`.

📄️ Get Space Overview

Retrieves detailed information about a specific Space, including: <br/> - Metadata and location (`FloorNumber`, `FloorName`, `BuildingUuid`, `BuildingName`)<br/> - Latest available environmental metrics (Temperature, Humidity, CO₂)<br/> - Latest available utility consumption (Electricity, Water, Gas, Heating, Cooling)<br/> <br/><br/>If a Space belongs to a Cluster, `ClusterUuid`/`ClusterName` will be set and data appears under `ClusterConsumption`; otherwise `ClusterConsumption` is null and individual `Consumption` is returned.

📄️ Get Space Aggregated Metrics

Retrieves aggregated consumption metrics over time for a Space or its associated Cluster, with configurable granularity (hourly, daily, weekly, monthly).<br/><br/>Note: hourly granularity only supported for temperature, co2, and humidity metrics. <br/><br/>If the Space belongs to a Cluster, metrics reflect cluster-wide consumption; otherwise, they reflect the individual Space.

📄️ Get Bulk Space Aggregated Metrics

Retrieves aggregated metrics for up to 40 spaces in a single request, with configurable granularity (hourly, daily, weekly, monthly).<br/><br/>Specify a comma-separated list of space UUIDs via the `spaceUuids` query parameter.<br/><br/>Supported metric types: `electricity`, `heating`, `water`, `gas`, `cooling`, `temperature`, `co2`, `humidity`, `occupancy`.<br/><br/>Note: hourly granularity only supported for temperature, co2, and humidity metrics.<br/><br/>If a Space belongs to a Cluster, utility metrics reflect cluster-wide consumption; otherwise, they reflect the individual Space.<br/><br/>Spaces that cannot be found are returned in the errors array.

📄️ Space Grant Consent

Grants consent to collect data for a space. Current accepted consent type is Utility.<br/><br/>Space must have a N3rgy Smart Meter device.

📄️ Space Revoke Consent

Revokes consent to collect data for a space. Current accepted consent type is Utility.<br/><br/>Space must have a N3rgy Smart Meter device.

📄️ Space Get Consents

Gets a single consent by Uuid or all consents for a specific tenancy by referenceId.<br/><br/>Space must have a N3rgy Smart Meter device.