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

List and query groups. You can search for groups by combining various query parameters.

**Note:** When using the `Return All Pages` parameter, the size of each retrieved page can be controlled using the `Page Size` parameter, with a minimum value of `50`.

<Note>
  External Documentation

  To learn more, visit the [Authentik documentation](https://docs.goauthentik.io/docs/developer-docs/api/reference/core-groups-list).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter           | Description                                                                                                  |
  | ------------------- | ------------------------------------------------------------------------------------------------------------ |
  | Group Name          | Query by the name of the group.                                                                              |
  | Members By Username | Query by a comma separated list of the group's member usernames. Can be obtained by the `List Users` action. |
  | Page Number         | The page number being requested.                                                                             |
  | Page Size           | Number of results to return per page.                                                                        |
  | Return All Pages    | Automatically fetch all resources, page by page.                                                             |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter     | Description                                                                                            |
  | ------------- | ------------------------------------------------------------------------------------------------------ |
  | Attributes    | Query by the additional attributes.                                                                    |
  | Include Users | Include the group's users in the response.                                                             |
  | Is Superuser  | Is the group designated as a superuser group.                                                          |
  | Members By ID | Query by a comma separated list of the group's member IDs. Can be obtained by the `List Users` action. |
  | Order By      | Which field to use when ordering the results.                                                          |
  | Search        | A search term.                                                                                         |
</div>

## Example Output

```json theme={"dark"}
{
	"pagination": {
		"next": 0,
		"previous": 1,
		"count": 4,
		"current": 1,
		"total_pages": 0,
		"start_index": 2,
		"end_index": 5
	},
	"results": [
		{
			"pk": "<string>",
			"num_pk": 32226,
			"name": "<string>",
			"is_superuser": false,
			"parent": null,
			"parent_name": null,
			"users": [],
			"users_obj": [],
			"attributes": {},
			"roles": [],
			"roles_obj": []
		},
		{
			"pk": "<string>",
			"num_pk": 8839,
			"name": "<string>",
			"is_superuser": true,
			"parent": null,
			"parent_name": null,
			"users": [
				11
			],
			"users_obj": [
				{
					"pk": 12,
					"username": "<string>",
					"name": "<string>",
					"is_active": true,
					"last_login": "<string>",
					"email": "<string>",
					"attributes": {},
					"uid": "<string>"
				}
			],
			"attributes": {},
			"roles": [],
			"roles_obj": []
		}
	]
}
```

## Workflow Library Example

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