GitLab API

GitlabTool

Actions1095

Groups → getApiV4GroupsIdGroupsShared

AI-generated

Summary

Retrieves a paginated list of sub-groups that are shared with the specified parent group, optionally filtering by visibility, access level, or search term.

Inputs

  • id (required) — The ID or path of the parent group.
  • skip_groups — Array of group IDs to exclude from the list.
  • visibility — Limit the results to groups with a specific visibility (private, internal, public).
  • search — Search for a specific group name or path.
  • min_access_level — Minimum access level of the authenticated user.
  • order_by — Field to order results by (name, path, id, similarity). Default is 'name'.
  • sort — Sort direction: 'asc' or 'desc'. Default is 'asc'.
  • page — Current page number for pagination. Default is 1.
  • per_page — Number of items per page. Default is 20.
  • with_custom_attributes — Include custom attributes in the response. Default is false.

Output shape

a list of items, each representing a shared group

Uses pagination; the 'page' and 'per_page' parameters control the result set size.

Examples

Example 1: List all shared groups for group ID 42

Path: /api/v4/groups/42/groups/shared

Example 2: Find shared groups that are public

Query: visibility=public

Example 3: Search for a specific group among shared groups

Query: search=engineering

Links

Discussion