GitLab API icon

GitLab API

Gitlab

Actions1062

Groups → getApiV4GroupsIdDescendantGroups

AI-generated

Summary

Retrieve descendant groups of a specified GitLab group by its ID, optionally filtering and customizing the results using various query parameters.

Inputs

  • id (required) — The ID of the parent group whose descendant groups are to be retrieved.
  • statistics — Include project statistics in the response.
  • skip_groups — Array of group IDs to exclude from the returned list.
  • all_available — Return all groups the authenticated user has access to.
  • visibility — Filter groups by visibility: private, internal, or public.
  • search — Search term to filter groups by name.
  • owned — Limit results to groups owned by the authenticated user.
  • order_by — Field to order results by: name, path, id, or similarity.
  • sort — Sort direction for results: ascending (asc) or descending (desc).
  • min_access_level — Minimum access level of the authenticated user required to include the group.
  • top_level_only — Include only top-level groups.
  • repository_storage — Filter groups by the repository storage they use.
  • marked_for_deletion_on — Filter groups by the date they were marked for deletion.
  • page — Page number for paginated results.
  • per_page — Number of groups to return per page.
  • with_custom_attributes — Include custom attributes in the response.

Output shape

a list of group objects representing the descendant groups of the specified group ID

The response supports pagination using 'page' and 'per_page' parameters. Filtering and sorting options adjust the returned groups accordingly. Authentication is required unless 'Skip Authentication' is set to true.

Links

Discussion