[POST] .../v1/usergroup/get
Returns information about group users. Use this method to retrieve the user-group tree before assigning users, roles or group-level schedules. The response returns UserGroup rows with id, parent_id, name, child_count and last_update; the request body is required and supports filters for id and parent_id. Missing body, denied permission, invalid filters and persistent lookup failures are returned as HTTP 200 ErrorResult business errors.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Optional | Optional filters by fields available for this API method. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| id | int | Group IDs. |
| parent_id | int | Parent group IDs. |
Request Example
{
"filters": [
{
"Field": "parent_id",
"Operator": "Equal",
"Value": "0"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of UserGroup | Result object. |
Response Example
{
"ok": true,
"result": [
{
"id": 3,
"parent_id": 0,
"name": "Managers",
"child_count": 2,
"last_update": 1712345600
}
]
}