GitLab API icon

GitLab API

Gitlab

Actions1062

Groups → getApiV4GroupsIdSubgroups

AI-generated

Summary

Retrieve the list of subgroups for a specified GitLab group by its ID, with optional query parameters to filter, sort, and paginate the results.

Inputs

  • id (required) — The ID of the parent GitLab group whose subgroups are to be retrieved.
  • statistics — Include project statistics for each subgroup.
  • skip_groups — An array of group IDs to exclude from the retrieved subgroups list.
  • all_available — Show all groups the authenticated user has access to.
  • visibility — Filter subgroups by visibility: private, internal, or public.
  • search — Search subgroups by name.
  • owned — Limit to subgroups owned by the authenticated user.
  • order_by — Order results by name, path, id, or similarity (when searching). Defaults to 'name'.
  • sort — Sort order: ascending ('asc') or descending ('desc'). Defaults to 'asc'.
  • min_access_level — Filter subgroups by minimum access level of the authenticated user (values like 10, 15, 20, 30, 40, 50).
  • top_level_only — Include only top-level groups.
  • repository_storage — Filter by repository storage used by the subgroup.
  • marked_for_deletion_on — Filter subgroups marked for deletion on a certain date.
  • page — Page number for pagination (default 1).
  • per_page — Number of items per page for pagination (default 20).
  • with_custom_attributes — Include custom attributes in the response.

Output shape

a JSON list of subgroup objects from the specified GitLab group

Supports pagination and various filtering options via query parameters; authenticated access is required unless Skip Authentication is enabled.

Links

Discussion