> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List User Groups

Retrieve a list of user groups.

**Note:** To pass additional Zabbix parameters, use the **Additional Parameters** field with the following format:

```
{
  "params": {
    "output": "extend",
    "selectUsers": "extend"
  }
}
```

<Note>
  External Documentation

  To learn more, visit the [Zabbix documentation](https://www.zabbix.com/documentation/7.4/en/manual/api/reference/usergroup/get).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter      | Description                                                                                                                                                                                                                                 |
  | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Limit          | The maximum number of results to return.                                                                                                                                                                                                    |
  | Request ID     | The ID to send with the request.                                                                                                                                                                                                            |
  | Search         | The search query to filter events by.<br /><br />For more information about the search supported types, refer to [Zabbix data types documentation](https://www.zabbix.com/documentation/7.4/en/manual/api/reference_commentary#data-types). |
  | Sort Field     | Select the field to sort results by.                                                                                                                                                                                                        |
  | Sort Order     | Select the sort order.                                                                                                                                                                                                                      |
  | Status         | Select the user group status to filter results by.                                                                                                                                                                                          |
  | User Group IDs | A comma-separated list of user group IDs to filter results by.                                                                                                                                                                              |
  | User IDs       | A comma-separated list of user IDs to filter results by.                                                                                                                                                                                    |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter             | Description                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Additional Parameters | A JSON object for additional body parameters. Values specified in this parameter will override equivalent parameters.<br /><br />For example:<br /><pre><code>\{<br />    "first\_key": 12345,<br />    "second\_key": "some\_value"<br />}</code></pre>The object must follow the vendor's structure as defined in the [API documentation](https://www.zabbix.com/documentation/7.4/en/manual/api/reference/usergroup/get). |
</div>

## Example Output

```json theme={"dark"}
{
	"jsonrpc": "2.0",
	"result": [
		{
			"usrgrpid": "7",
			"name": "Zabbix administrators",
			"gui_access": "0",
			"users_status": "0",
			"debug_mode": "1",
			"userdirectoryid": "0",
			"mfa_status": "0",
			"mfaid": "0"
		}
	],
	"id": 1
}
```

## Workflow Library Example

[List User Groups with Zabbix and Send Results Via Email](https://library.blinkops.com/workflows/list-user-groups-with-zabbix-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-user-groups-with-zabbix-and-send-results-via-email/canvas" />
</div>