Skip to main content

Query signature

The location root query returns a single location by ID. For browsing the hierarchy, use locations nested on Building or Location.
All root queries require siteId. See multi-tenant scoping. Examples below omit siteId for brevity.

Arguments

Return fields

Spatial hierarchy

Buildings contain a nested hierarchy of locations:

Examples

Browse the full spatial tree

Start from a building and drill into its location hierarchy:

Get a specific location with its equipment

Filter locations by type

Find only floors (skip wings):
recursive: true flattens the hierarchy, returning all floors across all wings in a single list.

All equipment on a floor

Returns Tower West Level 1 → Tower West (Wing).

Locations vs zones

Locations represent physical space: where things are. Zones represent conditioned space: what equipment serves. A floor can contain multiple zones. A zone can span multiple rooms. Use location for spatial questions, zones for HVAC questions.