GitLab API

GitlabTool

Actions1095

Groups → getApiV4Groups

AI-generated

Summary

Fetches a paginated list of GitLab groups using the GitLab API v4, filtering by visibility, ownership, search terms, and access levels.

Inputs

  • queryParameters (required) — Filters to apply to the group list. Includes options for visibility, search terms, pagination, access levels, and inclusion of statistics or custom attributes. All parameters are optional.
  • skipAuthentication — If true, bypasses the node's authentication requirement.
  • baseUrl — The base URL for the GitLab instance (default: https://gitlab.com).
  • method — HTTP method to use (default: GET).

Output shape

a list of items, each representing a GitLab group object with properties like id, name, path, and visibility.

Returns a paginated list. Use the 'page' and 'per_page' parameters to control pagination. The node inherits the standard OpenAPI list behavior from its parent class.

Examples

Example 1: Retrieve all public groups owned by the authenticated user

Query: Owned=true, Visibility=public

Example 2: Search for a specific group by name and limit results to the first page

Query: Search='MyGroup', Page=1, Per_page=20

Example 3: Get a list of top-level groups with statistics included

Query: Top_level_only=true, Statistics=true, With_custom_attributes=true

Links

Discussion