HomeGuidesAPI Reference
API Reference

Get group(s) by ID or retrieve all groups

Retrieves groups from the Orchestrator hierarchy. Without the 'id' parameter, returns all groups accessible to the user (filtered by RBAC settings). With 'id', returns the specific group. Supports ETag caching via If-None-Match header. System groups: 0.Network (Root), 1.Network (Internal), 2.Network (Auto-discovered). User-defined groups start at 3.Network.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^[0-9]+\.Network$

Group identifier in format '{number}.Network'. When omitted, returns all groups; when provided, returns the specific group.

Responses

304

Not Modified - The group data has not changed since the last request. Returned when If-None-Match header matches the current ETag.

401

Unauthorized - Authentication required or session expired

403

Forbidden - User lacks READ or READ_WRITE permission

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json