GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node operation retrieves descendant groups of a specified GitLab group using the GitLab API. It is useful for scenarios where you need to explore or manage group hierarchies within GitLab, such as fetching all subgroups under a parent group for reporting, automation, or synchronization purposes.

Use Case Examples

  1. Fetch all descendant groups of a specific GitLab group by providing the group ID.
  2. Filter descendant groups by visibility or ownership to get a refined list.
  3. Paginate through descendant groups when dealing with large group hierarchies.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to connect to, default is https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Collection of optional query parameters to filter and control the response, such as statistics inclusion, group visibility, search terms, pagination, and access levels.
Path Parameters Path parameters including the required group ID to specify which group's descendant groups to retrieve.

Output

JSON

  • id - Unique identifier of the descendant group
  • name - Name of the descendant group
  • path - Path of the descendant group
  • visibility - Visibility level of the descendant group (private, internal, public)
  • statistics - Project statistics if requested
  • parent_id - ID of the parent group
  • custom_attributes - Custom attributes included if requested
  • marked_for_deletion_on - Date when the group was marked for deletion, if applicable

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the provided group ID is valid and accessible by the authenticated user to avoid 404 or permission errors.
  • Check that the API key credential has sufficient permissions to read group information.
  • Verify query parameters for correct types and values to prevent request failures.

Links

Discussion