GitLab API

GitlabTool

Actions1095

Projects → getApiV4ProjectsIdInvitedGroups

AI-generated

Summary

Retrieve the list of groups invited to a specified GitLab project, optionally filtered by relation, search terms, minimum access level, pagination, and inclusion of custom attributes.

Inputs

  • id (required) — The ID or URL-encoded path of the project whose invited groups you want to retrieve.
  • relation — Filter invited groups by their relation to the project; possible values are 'direct' or 'inherited'.
  • search — Search term to filter groups by name or other properties.
  • min_access_level — Minimum access level of the authenticated user to limit groups returned; possible values include 10, 15, 20, 30, 40, 50.
  • page — Page number for paginated results; defaults to 1.
  • per_page — Number of groups to return per page; defaults to 20.
  • with_custom_attributes — Boolean flag to include custom attributes in the response; defaults to false.

Output shape

a JSON array of group objects representing the invited groups for the specified project

Supports pagination through 'page' and 'per_page' parameters. The results can be filtered via query parameters as specified. Returns only groups with access to the project as per the filter criteria.

Links

Discussion