GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the list of users who have starred a specific GitLab project. It is useful for scenarios where you want to see who has shown interest in a project by starring it, such as for community engagement analysis or project popularity tracking. For example, a project maintainer might use this to identify active users or contributors.

Use Case Examples

  1. Get the list of starrers for a project by providing the project ID.
  2. Search for starrers matching a specific username within a project.
  3. Paginate through the list of starrers to handle large projects with many users.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters to filter and paginate the list of starrers.
Path Parameters Path parameters required for the request, specifically the project ID.

Output

JSON

  • id - The unique identifier of the user who starred the project.
  • username - The username of the user who starred the project.
  • name - The full name of the user who starred the project.
  • state - The state of the user (e.g., active).
  • avatar_url - URL to the user's avatar image.
  • web_url - URL to the user's profile page.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Check that the GitLab API key credential is valid and has sufficient permissions to access project starrers.
  • If pagination parameters are used, verify that page and per_page values are within acceptable ranges.
  • Common error messages include 404 Not Found if the project ID is invalid or inaccessible, and 401 Unauthorized if authentication fails.

Links

Discussion