templategroup_get
Read-only
Retrieve template groups from Zabbix to organize templates for access control and logical grouping; filter, search, sort, and limit results.
Instructions
Retrieve template groups. Template groups organize templates in the same way that host groups organize hosts. They are used for access control and logical grouping.
Input Schema
TableJSON 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: groupid, name, uuid. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the templategroup object to return. Pass 'extend' for all, 'count' for the number of matches only, or a comma-separated list of property names. Default when omitted: groupid, name. Properties: groupid, name, uuid. | |
| 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, uuid. | |
| server | No | Target Zabbix server. Available: default. Defaults to 'default' if omitted. | |
| groupids | No | Return only template groups with the given 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: groupid, name (comma-separated for several; pair with 'sortorder'). No other property is sortable. | |
| sortorder | No | Sort order: 'ASC' (ascending) or 'DESC' (descending). | |
| 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). | |
| templateids | No | Return only template groups that contain the given templates. | |
| extra_params | No | Other native templategroup.get parameters, merged into the request as-is. Parameters: graphids, limitSelects, triggerids, with_graph_prototypes, with_graphs, with_httptests, with_item_prototypes, with_items, with_simple_graph_item_prototypes, with_simple_graph_items, with_triggers. Sub-object selects (value 'extend', 'count' or a list of property names): selectTemplates. 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. | |
| with_templates | No | Only return template groups that contain at least one template. | |
| searchWildcardsEnabled | No | If true, enable * and ? wildcards in search patterns. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |