GitLab API

GitlabTool

Actions1000

Overview

This node operation allows users to retrieve groups from the GitLab API (v4). It supports various query parameters to filter, sort, and paginate the list of groups, such as filtering by visibility, ownership, access level, and more. This is useful for scenarios where you need to programmatically access and manage GitLab groups, for example, to list all groups a user has access to, search for specific groups, or gather group statistics.

Use Case Examples

  1. Retrieve all public groups with statistics included.
  2. Search for groups owned by the authenticated user and sort them by name in ascending order.
  3. Exclude specific group IDs from the results and paginate through the list.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, hidden unless Skip Authentication is false. Defaults to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send the request to. Defaults to https://gitlab.com.
Method The HTTP method to use for the request. Defaults to GET.
Query Parameters Collection of optional query parameters to filter and control the groups returned by the API, such as statistics inclusion, visibility, search term, ownership, sorting, pagination, and more.

Output

JSON

  • id - The unique identifier of the group.
  • name - The name of the group.
  • path - The path or URL slug of the group.
  • description - Description of the group.
  • visibility - Visibility level of the group (private, internal, public).
  • lfs_enabled - Whether Large File Storage (LFS) is enabled for the group.
  • avatar_url - URL to the group's avatar image.
  • web_url - Web URL to access the group in GitLab.
  • request_access_enabled - Whether request access is enabled for the group.
  • full_name - Full name of the group.
  • full_path - Full path of the group.
  • parent_id - ID of the parent group, if any.
  • projects - List of projects under the group.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access groups.
  • Verify the baseUrl is correct and reachable, especially if using a self-hosted GitLab instance.
  • Check that query parameters are valid and conform to expected types and values to avoid API errors.
  • Common error messages include authentication failures (401 Unauthorized), invalid parameters (400 Bad Request), and permission denied (403 Forbidden). Resolving these typically involves correcting credentials, parameters, or user permissions.

Links

Discussion