Skip to content

GroupRoute

HTTP API schema

← HTTP API reference

A provider-reported group route (for example a vacuum map or room, a lighting room or a speaker group) as carried by discovery. It is shared by the route-discovery report message and `SynchronizationRequest.groupRoutes` so both decode to the same model.

GroupRoute fields

pluginProfileIdstring

Stable group-route profile ID selected from the registered V2 plugin declaration.

minLength: 1

ontologicalTypesarray<string>

Actual classifications of the native group route, constrained by its selected plugin profile for V2 discovery.

pluginRouteIdstringRequired

Plugin-owned stable identifier of the group route. Must be unique across routes and group routes within one plugin and auth link.

minLength: 1

namestringRequired

The name of the associated group route

interfacesarray<RouteInterface>
memberPluginRouteIdsarray<string>

List of plugin route IDs that are members of this group route

uniqueItems: true

pluginCustomMetadataobject

Private plugin metadata (native map, segment or cloud room addressing) returned to the plugin on dispatch; never exposed as application data.

View source specification ↗