Get Organization Hierarchy
GET/iot/pub/v1/organization
Retrieve the organization hierarchy as one list: the top-level group (named after the tenant), its groups and subgroups, and the sites in each group, as shown on the Sites page of the Device Security GUI.
Each node has its name, its type (root, group or site), the name of its parent group, and its path (the names from the top-level group down to the node). For a site, name is the site's external_id, the value shown as "Name" in the GUI.
Nodes are listed depth first, and the groups and sites under each parent are sorted by name. Sites that are not in any group are listed under the top-level group, and groups without sites are included. Only the groups and sites your account can access are returned; the top-level group is always returned.
Use group to get one group and everything beneath it, and type to keep one kind of node. An unknown query parameter returns HTTP 400.
For customers using the IoT Standalone Portal, refer to IoT Standalone Public API Authentication page.
Request
Responses
- 200
- 4XX
- 5XX
Organization Hierarchy Successfully Retrieved
Client Error Response
Server Error Response