[POST] .../v1/usergrouprole/get
Returns information about roles group. Use this method to list roles assigned to a user group before editing group-level permissions. The response returns UserGroupRole rows with assignment id, group_id and the role object; the request body is required and supports filters for group_id. The caller must have group-role get permission 18 and group_id must be positive because request validation runs before the controller action. Missing body, invalid group_id, 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 |
|---|---|---|
| group_id | int | Group ID. |
Request Example
{
"filters": [
{
"Field": "group_id",
"Operator": "Equal",
"Value": "3"
}
]
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of UserGroupRole | Result array. |
Response Example
{
"ok": true,
"result": [
{
"id": 61,
"group_id": 3,
"role": {
"id": 4,
"name": "Cashier",
"description": "POS operator role",
"last_update": 1712345600
}
}
]
}