Skip to main content
GET
/
orgs
/
{org_id}
/
hierarchy
Get Org Hierarchy
curl --request GET \
  --url https://api.example.com/orgs/{org_id}/hierarchy
{
  "entries": [
    {
      "node_id": "<string>",
      "title": "<string>",
      "path": "<string>",
      "depth": 123,
      "is_directory": true,
      "org_id": "<string>",
      "org_name": "<string>"
    }
  ],
  "total": 123
}

Headers

authorization
string | null

Path Parameters

org_id
string<uuid>
required

Response

Successful Response

Response for the containment hierarchy of an organization.

entries
HierarchyEntryResponse · object[]
required

Hierarchy entries

total
integer
required

Total number of entries