Get Group Tree

GET

https://platform-api.convirza.com/v3/groups/tree

Groups

Last modified:2026-04-03 14:27:57

Returns the complete organizational hierarchy as a nested tree, scoped to the authenticated user's account access.

Tree structure
Each node in the tree contains:

org_unit_id and org_unit_name — the group's unique identifier and display name.

org_unit_parent_id — the parent node's ID (null for the root).

coded_level — a dotted-notation level string (e.g. 1.2.3) that encodes depth and position for display purposes.

children — an array of child nodes, recursively structured.

Active filter
Set active=true (default) to return only active groups — the standard view for UI pickers and dropdowns. Set active=false to include inactive/archived groups as well, useful for admin audit views.

Authorization
The tree is automatically scoped to the org units accessible to the authenticated user. Users with narrow access see only their portion of the hierarchy.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Successfully retrieved group tree

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://platform-api.convirza.com/v3/groups/tree?active' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "groups": [
            {
                "org_unit_id": 1001,
                "text": "Corporate Headquarters",
                "code": "1",
                "group_level": 1
            },
            {
                "org_unit_id": 1002,
                "text": "Sales Division",
                "code": "1.1",
                "group_level": 2
            },
            {
                "org_unit_id": 1003,
                "text": "East Coast Sales",
                "code": "1.1.1",
                "group_level": 3
            }
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

List Child Groups

Get Group Details