> ## 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

This endpoint returns all User Groups.

Available filter fields:

* `name`
* `disabled`
* `type`
* `suggestionCounts.add`
* `suggestionCounts.remove`
* `suggestionCounts.total`
* `attributes.sudo.enabled`
* `attributes.sudo.withoutPassword`

#### Sample Request

```
curl -X GET https://console.jumpcloud.com/api/v2/usergroups \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
```

## Basic Parameters

<div className="integrations-table">
  | Parameter | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
  | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Fields    | The comma separated fields included in the returned records.<br />If omitted, the default list of fields will be returned.                                                                                                                                                                                                                                                                                                                                                                                                            |
  | Filter    | A filter to apply to the query.<br /><br />**Filter structure**: `&lt;field&gt;:&lt;operator&gt;:&lt;value&gt;`.<br /><br />**field** = Populate with a valid field from an endpoint response.<br /><br />**operator** =  Supported operators are: eq, ne, gt, ge, lt, le, between, search, in.<br />*Note: v1 operators differ from v2 operators.*<br /><br />**value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.<br /><br />**EX:** `GET /api/v2/groups?filter=name:eq:Test+Group`. |
  | Limit     | The number of records to return at once. Limited to 100.                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  | Skip      | The offset into the records to return.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | Sort      | The comma separated fields used to sort the collection.<br />Default sort is ascending, prefix with `-` to sort descending.                                                                                                                                                                                                                                                                                                                                                                                                           |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter       | Description                                                         |
  | --------------- | ------------------------------------------------------------------- |
  | Organization ID | Organization identifier that can be obtained from console settings. |
</div>

## Example Output

```json theme={"dark"}
[
	{
		"attributes": {
			"sudo": {
				"enabled": true,
				"withoutPassword": true
			},
			"ldapGroups": [
				{
					"name": "string"
				}
			],
			"posixGroups": [
				{
					"id": 0,
					"name": "string"
				}
			],
			"radius": {
				"reply": [
					{
						"name": "string",
						"value": "string"
					}
				]
			},
			"sambaEnabled": true
		},
		"description": "string",
		"email": "string",
		"id": "string",
		"memberQuery": {
			"queryType": "FilterQuery",
			"filters": [
				{
					"field": "string",
					"operator": "eq",
					"value": "string"
				}
			]
		},
		"memberQueryExemptions": [
			{
				"attributes": {},
				"id": "string",
				"type": "string"
			}
		],
		"memberSuggestionsNotify": true,
		"membershipAutomated": true,
		"name": "string",
		"suggestionCounts": {
			"add": 0,
			"remove": 0,
			"total": 0
		},
		"type": "user_group"
	}
]
```

## Workflow Library Example

[List User Groups with Jumpcloud and Send Results Via Email](https://library.blinkops.com/workflows/list-user-groups-with-jumpcloud-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-jumpcloud-and-send-results-via-email/canvas" />
</div>