Skip to main content
Retrieve a list of groups.
External DocumentationTo learn more, visit the GitLab documentation.

​
Parameters

ParameterDescription
Order BySelect the field to order the results by.
PageThe page number to get results from. The value must be greater than 0.

Note: There is a maximum allowed offset, for more information refer to the GitLab Documentation.
Per PageThe maximum number of results to return.

Note: There is a maximum allowed offset, for more information refer to the GitLab Documentation.
Return All PagesAutomatically fetch all resources, page by page.
SearchSearch authorized groups matching a specified query.
Sort OrderThe order to sort the results by.
VisibilitySelect the visibility level of the projects to filter results by.

​
Example Output

[
	{
		"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
Workflow LibraryPreview this Workflow on desktop