List the subgroups of list of groups
Returns a list of subgroup UUIDs for one or more parent groups. Use the parent_group_ids parameter to specify which parent groups to query, and the immediate parameter to control whether the response includes only direct children or all descendants at every level of the hierarchy.
Note that the response contains only subgroup UUIDs — not full group objects. Use GET /enterprise/{enterprise_id}/devicegroup/{group_id}/ to retrieve full details for any returned group ID.
Query parameters
parent_group_ids (optional) — Comma-separated list of parent group UUIDs to query; omitting this parameter may return subgroups across all groups immediate (optional, default: false) — When false, returns all descendant subgroups at every level; when true, returns only the immediate (direct) children of the specified parent groups
Common Use Cases
Traversing a group hierarchy to discover all subgroups beneath one or more parent groups Checking whether a group has children before deciding to delete or restructure it Collecting a full list of descendant group IDs to use as targets for bulk operations
Best Practices
When only direct children are needed, set immediate=true to avoid retrieving the full descendant tree, which may be large in deep hierarchies Since the response returns UUIDs only, plan for follow-up calls to GET /devicegroup/{group_id}/ if group names, device counts, or other metadata are required Use parent_group_ids to scope the query — querying without it may return more data than expected
Query parameters
Filter by parent group ids. This is a comma separated list of group ids.
This is a boolean value. If true, only immediate subgroups are returned.
Response
successful operation