GitLab API icon

GitLab API

Gitlab

Actions1062

Groups → getApiV4GroupsIdInvitedGroups

AI-generated

Summary

Retrieve a list of groups invited to a specified GitLab group by its ID, with optional filtering and pagination parameters.

Inputs

  • id (required) — The ID of the GitLab group to fetch invited groups for.
  • relation — Filter to include specific group relations such as 'direct' or 'inherited'.
  • search — Search term to filter invited groups by name or other attributes.
  • min_access_level — Minimum access level (10,15,20,30,40,50) of the authenticated user to filter invited groups.
  • page — Page number for paginated results (default is 1).
  • per_page — Number of invited group items per page (default is 20).
  • with_custom_attributes — Boolean flag to include custom attributes in each invited group's response.

Output shape

a list of invited groups as returned by the GitLab API v4 endpoint

Supports pagination via 'page' and 'per_page' query parameters; filtering by relation, search term, and minimum access level is supported; the response includes optional custom attributes if requested. Authentication is required unless skipped via the 'Skip Authentication' option.

Examples

Example 1: Get the first page of invited groups for group with ID '123' including only direct relations and groups where the authenticated user has access level 30 or higher.

Set 'id' to '123', 'relation' to 'direct', 'min_access_level' to 30, 'page' to 1, and optionally 'per_page' to desired count.

Links

Discussion