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

Retrieve a list of groups.

<Note>
  External Documentation

  To learn more, visit the [GitLab documentation](https://docs.gitlab.com/api/groups/#list-groups).
</Note>

## Parameters

<div className="integrations-table">
  | Parameter        | Description                                                                                                                                                                                                                                                                                                        |
  | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | Order By         | Select the field to order the results by.                                                                                                                                                                                                                                                                          |
  | Page             | The page number to get results from. The value must be greater than `0`.<br /><br />**Note:** There is a maximum allowed offset, for more information refer to the [GitLab Documentation](https://docs.gitlab.com/administration/instance_limits/#max-offset-allowed-by-the-rest-api-for-offset-based-pagination). |
  | Per Page         | The maximum number of results to return.<br /><br />**Note:** There is a maximum allowed offset, for more information refer to the [GitLab Documentation](https://docs.gitlab.com/administration/instance_limits/#max-offset-allowed-by-the-rest-api-for-offset-based-pagination).                                 |
  | Return All Pages | Automatically fetch all resources, page by page.                                                                                                                                                                                                                                                                   |
  | Search           | Search authorized groups matching a specified query.                                                                                                                                                                                                                                                               |
  | Sort Order       | The order to sort the results by.                                                                                                                                                                                                                                                                                  |
  | Visibility       | Select the visibility level of the projects to filter results by.                                                                                                                                                                                                                                                  |
</div>

## Example Output

```json theme={"dark"}
[
	{
		"id": 1,
		"name": "Foobar Group",
		"path": "foo-bar",
		"description": "An interesting group",
		"visibility": "public",
		"share_with_group_lock": false,
		"require_two_factor_authentication": false,
		"two_factor_grace_period": 48,
		"project_creation_level": "developer",
		"auto_devops_enabled": null,
		"subgroup_creation_level": "owner",
		"emails_disabled": null,
		"emails_enabled": null,
		"mentions_disabled": null,
		"lfs_enabled": true,
		"default_branch": null,
		"default_branch_protection": 2,
		"default_branch_protection_defaults": {
			"allowed_to_push": [
				{
					"access_level": 40
				}
			],
			"allow_force_push": false,
			"allowed_to_merge": [
				{
					"access_level": 40
				}
			]
		},
		"avatar_url": "http://localhost:3000/uploads/group/avatar/1/foo.jpg",
		"web_url": "http://localhost:3000/groups/foo-bar",
		"request_access_enabled": false,
		"repository_storage": "default",
		"full_name": "Foobar Group",
		"full_path": "foo-bar",
		"file_template_project_id": 1,
		"parent_id": null,
		"created_at": "2020-01-15T12:36:29.590Z",
		"ip_restriction_ranges": null
	}
]
```

## Workflow Library Example

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