GitLab API

GitlabTool

Actions1095

Groups → getApiV4GroupsIdDescendantGroups

AI-generated

Summary

Retrieves a paginated list of descendant groups for a specific GitLab group, filtering and sorting options available.

Inputs

  • id (required) — The ID of a group.
  • skipAuthentication — Skip GitLab authentication (if allowed by the instance).
  • baseUrl — The base URL of the GitLab instance (default: https://gitlab.com).
  • statistics — Include project statistics in the response.
  • skip_groups — Array of group IDs to exclude from the list.
  • all_available — Show all groups that you have access to.
  • visibility — Limit the result by visibility (private, internal, public).
  • search — Search for a specific group.
  • owned — Limit the result to groups owned by the authenticated user.
  • order_by — Order by name, path, id, or similarity (default: name).
  • sort — Sort by ascending or descending (default: asc).
  • min_access_level — Minimum access level of the authenticated user (10, 15, 20, 30, 40, 50).
  • top_level_only — Only include top-level groups.
  • repository_storage — Filter by repository storage used by the group.
  • marked_for_deletion_on — Date when the group was marked for deletion.
  • page — Current page number (default: 1).
  • per_page — Number of items per page (default: 20).
  • with_custom_attributes — Include custom attributes in the response.

Output shape

A list of items, each containing details of a descendant group.

The response is paginated; use the page and per_page parameters to navigate. The node supports filtering by visibility, search terms, and user access level.

Examples

Example 1: List top-level descendant groups for a specific group ID.

Path parameter: id=123, Query parameter: top_level_only=true, per_page=50

Example 2: Find owned descendant groups and include statistics.

Query parameter: owned=true, statistics=true

Example 3: Search for a specific group name within the descendants.

Query parameter: search=project-name, order_by=name, sort=asc

Links

Discussion