Get Org Unit Hierarchy

GET

https://platform-api.convirza.com/v3/groups/org-list/{org_unit_id}

Groups

Last modified:2026-07-24 13:10:44

Returns the flattened list of organizational unit IDs that form the hierarchy rooted at the specified org_unit_id. This is the authoritative scope query — the returned IDs represent every org unit the specified group is responsible for, including itself, its immediate children (level 1), and all deeper descendants.

Typical use cases

Determine the full set of org unit IDs to pass when filtering calls, users, or reports by a parent group.

Build a selector showing all sub-groups within a region or department.

Verify the scope of an admin's visibility before performing bulk operations.

Behavior

Only active org units are returned (deleted or inactive units are excluded).

The specified org_unit_id itself is always included as the first element.

The hierarchy is traversed depth-first; order reflects the tree structure.

Authorization
The authenticated user must have access to the specified org_unit_id. Requesting a unit outside your account scope returns a 401.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200

application/json

Successfully retrieved organization list

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://platform-api.convirza.com/v3/groups/org-list/{org_unit_id}' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "org_unit_ids": [
            1001,
            1002,
            1003,
            2001,
            2002,
            2003,
            2004
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

List Groups

Update Group