device_get
Retrieve paired Zabbix mobile app devices and their onboarding status, owner, and last access. Filter by device, user, role, or user group to audit or manage endpoints.
Instructions
Retrieve paired mobile devices (Zabbix 8.0+): the Zabbix mobile app installations that users onboarded, with the owning userid, device name, status, activated_at and lastaccess. Filter by deviceids, userids, roleids or usrgrpids. Use device_offboard to revoke a device.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of records 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: activated_at, deviceid, lastaccess, name, status, userid, uuid. Text properties cannot be filtered; use 'search' for them. | |
| output | No | Properties of the device 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: deviceid, userid, name, status, lastaccess. Properties: activated_at, deviceid, lastaccess, name, status, userid, 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. | |
| roleids | No | Return only devices belonging to users with the given roles. | |
| userids | No | Return only devices belonging to the given users. | |
| 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. | |
| deviceids | No | Return only devices with the given IDs. | |
| sortfield | No | Sort by one or more of: deviceid, name (comma-separated for several; pair with 'sortorder'). No other property is sortable. | |
| sortorder | No | Sort order: 'ASC' or 'DESC'. | |
| usrgrpids | No | Return only devices belonging to users in the given user groups. | |
| countOutput | No | Return the count of matching devices instead of the records. | |
| extra_params | No | Other native device.get parameters, merged into the request as-is. device.get has no parameters beyond the typed ones. 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |