get_group_details
Retrieve group information and node details for ESP RainMaker devices. List all groups or show a specific group with customizable fields.
Instructions
Get comprehensive group information using Python library API.
Parameters:
group_id: ID of specific group to show (optional - if None, lists all groups)
include_nodes: Include detailed node information for groups
fields: List of group/sub-group keys to include (if None, includes all fields)
node_fields: List of node keys to include (if None, includes all node fields)
When group_id is None: Lists all groups with hierarchy When group_id is provided: Shows detailed information for that specific group When include_nodes is True: Includes comprehensive node details within groups
IMPORTANT USAGE GUIDELINES:
For home/room structure overview (recommended for most queries):
{ "include_nodes": true, "fields": ["group_id", "group_name", "type", "total", "sub_groups", "node_details"], "node_fields": ["node_id", "name", "type"] }For home/room structure with basic device info:
{ "include_nodes": true, "fields": ["group_id", "group_name", "type", "total", "sub_groups", "node_details"], "node_fields": ["node_id", "name", "type", "model", "fw_version"] }For detailed technical information:
{ "include_nodes": true, "fields": ["group_id", "group_name", "type", "total", "sub_groups", "node_details", "is_matter", "fabric_id", "primary", "mutually_exclusive"], "node_fields": ["node_id", "name", "type", "model", "fw_version", "status", "params"] }
Common Use Cases:
Query Type | Recommended Fields |
"Show my home" | Basic fields (option 1) to avoid large responses |
"List my devices" | Basic fields (option 1) for clear device listing |
"Check my rooms" | Basic fields (option 1) for room structure |
"Device details" | Detailed fields (option 3) for full information |
Note: When fields/node_fields are not provided, defaults to summary mode (basic fields) to avoid overwhelming responses.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group_id | No | ||
| include_nodes | No | ||
| fields | No | ||
| node_fields | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |