List Groups

GET

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

Groups

Last modified:2026-04-08 11:05:37

Returns the organizational unit hierarchy starting from the specified OUID.

Hierarchy structure:

Returns the parent organization unit.

Includes immediate children (level 1).

Includes grandchildren (level 2).

Request requirements:

ouid must be a positive integer representing a valid org unit ID.

Behavior:

Traverses organizational hierarchy tree.

Returns unit IDs in hierarchical order.

Includes only active organization units by default.

Response format:

Array of organization unit IDs in tree structure.

Preserves parent-child relationships.

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

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

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

Modified at 2026-04-08 11:05:37

Get Group Details

Get Org Unit Hierarchy