Skip to content
Authrim

Get an organization hierarchy.

GET
/api/admin/organizations/{id}/hierarchy
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/organizations/example/hierarchy?max_depth=10' \
  --header 'Authorization: Bearer <token>'

Returns the selected organization and descendants as a tree, including member counts and summary totals. The max_depth query controls recursive traversal depth.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Query Parameters

Section titled “Query Parameters ”
max_depth
integer
default: 10

Maximum descendant depth to traverse.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organization hierarchy response.

Media type application/json
object
organization
required
object
id
required
string
name
required
string
display_name
required
string | null
parent_id
required
string | null
depth
required
integer
is_active
required
boolean
member_count
required
integer
children
required
Array<object> recursive
key
additional properties
summary
required
object
total_organizations
required
integer
total_members
required
integer
max_depth
required
integer
key
additional properties
key
additional properties
Example generated
{
  "organization": {
    "id": "example",
    "name": "example",
    "display_name": "example",
    "parent_id": "example",
    "depth": 1,
    "is_active": true,
    "member_count": 1,
    "children": []
  },
  "summary": {
    "total_organizations": 1,
    "total_members": 1,
    "max_depth": 1
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}