GitLab API icon

GitLab API

Gitlab

Actions1062

Groups → getApiV4Groups

AI-generated

Summary

Retrieve a list of GitLab groups from the API v4 endpoint with various filtering and sorting options.

Inputs

  • skipAuthentication — Set to true to skip using authentication for this request.
  • baseUrl — Base URL of the GitLab instance, defaults to https://gitlab.com.
  • method (required) — HTTP method to use for the request; defaults to GET.
  • statistics — Boolean flag to include project statistics in the response.
  • skip_groups — Array of group IDs to exclude from the list.
  • all_available — Boolean to show all groups accessible to the authenticated user.
  • visibility — Limit groups by visibility status: private, internal, or public.
  • search — Search term to find specific groups.
  • owned — Boolean to limit groups owned by the authenticated user.
  • order_by — Field to order results by: name, path, id, or similarity.
  • sort — Sort direction: ascending (asc) or descending (desc).
  • min_access_level — Minimum access level of authenticated user to filter groups.
  • top_level_only — Boolean to include only top-level groups.
  • repository_storage — Filter groups by repository storage used.
  • marked_for_deletion_on — Date filter for groups marked for deletion.
  • page — Page number for paginated results; defaults to 1.
  • per_page — Number of items per page; defaults to 20.
  • with_custom_attributes — Boolean to include custom attributes in the response.

Output shape

a JSON array of group objects as returned by the GitLab /api/v4/groups endpoint.

Supports pagination through 'page' and 'per_page' query parameters. All filtering, sorting, and other options correspond directly to the GitLab API parameters.

Examples

Example 1: List all public groups containing 'dev' in their name, sorted by name ascending.

Set 'search' to 'dev', 'visibility' to 'public', 'order_by' to 'name', 'sort' to 'asc'.

Links

Discussion