GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the list of users who have starred a specific project on GitLab. 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. Retrieve the list of starrers for a project with a given project ID.
  2. Filter the starrers by a search term to find specific users who starred the 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 (boolean). Defaults to false.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send the request to, default is 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 or URL-encoded path.

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 GitLab profile

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • If authentication is skipped, the request may fail or return limited data depending on the GitLab instance's public access settings.
  • Check that the baseUrl is correctly set to the GitLab instance you intend to query, especially if using a self-hosted GitLab server.
  • Pagination parameters (page and per_page) should be set correctly to avoid missing data or excessive data retrieval.

Links

Discussion