GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves detailed information about a specific group from the GitLab API (version 4). It is useful for scenarios where you need to fetch group details such as group attributes, projects associated with the group, or custom attributes if available. For example, it can be used in automation workflows to get group metadata for reporting or integration purposes.

Use Case Examples

  1. Fetch details of a GitLab group by its ID to display group information in a dashboard.
  2. Retrieve a group's projects and custom attributes to synchronize with another system.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request, useful for public or unauthenticated API access.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Optional query parameters to customize the API request, including whether to include custom attributes and whether to include project details.
Path Parameters Path parameters required for the API request, specifically the group ID to identify which group to retrieve.

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 (e.g., private, internal, public).
  • custom_attributes - Custom attributes of the group if requested.
  • projects - List of projects under the group if requested.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID path parameter is correctly set; missing or incorrect ID will cause the request to fail.
  • Verify that the base URL is correct and accessible, especially if using a self-hosted GitLab instance.
  • If authentication is enabled, ensure the API key credential is valid and has sufficient permissions to access group details.
  • Check query parameters for correct boolean values; incorrect values may lead to unexpected API responses.

Links

Discussion