usergroup_get
Read-only
Retrieve Zabbix user groups to inspect permission mappings, group members, and tag-based access rules; use filters and select options to narrow results.
Instructions
Retrieve user groups. User groups are the primary mechanism for assigning permissions in Zabbix -- each group has a set of host group permissions (read, read-write, deny) and frontend/API access settings. Use selectRights to see the permission mappings, selectUsers to include group members, and selectTagFilters for tag-based permissions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results to return. | |
| filter | No | Return only results whose properties exactly match the given values (a single value or a list of values per key). Example: {"status": 0} or {"status": [0, 1]}. Keys: debug_mode, gui_access, mfa_status (7.0+), mfaid (7.0+), name, proxy_group_mode (8.0+), proxy_mode (8.0+), userdirectoryid (6.2+), users_status, usrgrpid. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the usergroup object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: usrgrpid, name. Properties: debug_mode, gui_access, mfa_status (7.0+), mfaid (7.0+), name, proxy_group_mode (8.0+), proxy_mode (8.0+), userdirectoryid (6.2+), users_status, usrgrpid. | |
| search | No | Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {"name": "web"}. Keys: name. | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| userids | No | Return only user groups that contain the given user IDs. | |
| raw_json | No | Strips the security disclaimer preamble from the response so it is pure JSON. Default: false. Requires the bearer token to have 'allow_raw_json' explicitly enabled by an operator in the admin portal - tokens without that policy receive a PolicyError instead. WARNING: setting true bypasses the prompt-injection mitigation marker that wraps untrusted Zabbix data (host names, item descriptions, problem text). LLM clients (Claude, GPT, Cursor, ...) should leave this false; only programmatic non-LLM consumers (Python scripts, n8n workflows that json.loads the result) should set true. | |
| sortfield | No | Sort by one or more of: usrgrpid, name (a list for several; pair with 'sortorder'). No other property is sortable. | |
| sortorder | No | Sort order: 'ASC' (ascending) or 'DESC' (descending). | |
| usrgrpids | No | Return only user groups with the given IDs. | |
| countOutput | No | Return the count of matching results instead of the actual data. | |
| searchByAny | No | If true, return results matching ANY search field (OR). Default is ALL fields (AND). | |
| extra_params | No | Other native usergroup.get parameters, merged into the request as-is. Parameters: mfa_status (7.0+), mfaids (7.0+), proxy_groupids (8.0+), proxyids (8.0+), status. Sub-object selects (value 'extend', 'count' or a list of property names): selectApmFilters (8.0+), selectHostGroupRights (6.2+), selectProxies (8.0+), selectProxyGroups (8.0+), selectRights (removed in 7.2), selectTagFilters, selectTemplateGroupRights (6.2+), selectUsers. Any other key is refused here, because Zabbix would silently ignore it. For a parameter you are sure exists on your release but is not listed, use zabbix_raw_api_call. | |
| searchWildcardsEnabled | No | If true, enable * and ? wildcards in search patterns. |