Skip to main content

What's New in v2

Partner API v2 introduces architectural improvements and new capabilities designed to simplify integration and expand functionality for resident-facing applications and data integrations.

Key Improvements​

Standardised Data Models and Error Handling​

Data structures now use consistent field names and response formats across all endpoints, reducing integration complexity. Error responses follow RFC 7807 Problem Details format with consistent error codes and structured error information.

Direct Device Management​

v2 provides dedicated endpoints for querying and controlling individual devices. Unlike v1, which required accessing device data through space endpoints, v2 enables direct device interaction for granular control.

Enhanced Cluster Support​

Cluster apartments now have explicit relationships with clear data inheritance patterns. The API differentiates between individual spaces and shared cluster resources, simplifying multi-occupancy scenario handling.

Site-Level Authentication​

Authentication scope has changed from tenant-level to site-level access, providing granular permission control and improved security isolation between sites within an organisation.

GUID-Based Identifiers​

All resource identifiers now use GUIDs instead of integers. Space IDs, building IDs, and floor IDs are now UUIDs, providing better uniqueness and consistency across the platform.

Production Sandbox Environment​

v2 introduces a dedicated production sandbox site with realistic dummy data, enabling partners to develop and test integrations. This sandbox follows the same data patterns and API behaviour as production sites, providing a reliable testing environment throughout the development lifecycle.

Coming Soon in v2​

Additional features are in development for future v2 releases.

Resident Challenges​

API endpoints for entering sustainability challenges between residents and tracking daily progress.

Consent management endpoints allowing control over resident data sharing preferences.

Integration Patterns​

v2's architecture supports common patterns for building resident-facing applications, with specific endpoints designed to simplify data integration.

Live Dashboard Pattern​

Display current space metrics with real-time comparisons using the space overview endpoint.

// Get current space overview with live data
const overview = await fetch(`${baseURL}/spaces/${spaceUuid}/overview`, {
  headers: headers,
});

const data = await overview.json();
// Use current metrics with today/yesterday consumption data
// Perfect for "live tiles" showing today vs yesterday

This pattern is ideal for realtime displays showing current consumption with today/yesterday values and current environmental readings.

Combine overview data, with a click through to show the aggregated historical data for that metric type.

// Step 1: Show overview in a "live tile"
const overview = await getSpaceOverview(spaceUuid);

// Step 2: When user clicks, show detailed trends
const trends = await fetch(
  `${baseURL}/spaces/${spaceUuid}/aggregate/electricity/daily?startDate=2025-01-01&endDate=2025-01-31`,
  { headers: headers },
);

// Perfect for interactive charts and trend visualization

Supports summary cards that expand into detailed graphs, progressive disclosure from high-level metrics to granular data, and interactive charts for usage pattern exploration.