GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves badges for a specific group in GitLab using the GitLab API v4. It is useful for scenarios where you want to list or manage badges associated with a group, such as displaying group achievements or status indicators in a project management or CI/CD pipeline context. For example, you can fetch badges to show on a dashboard or to automate badge management based on group activity.

Use Case Examples

  1. Fetch badges for a group by specifying the group's ID or URL-encoded path.
  2. Paginate through badges using page and per_page query parameters.
  3. Filter badges by name to find specific badges within a group.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to send the request to.
Method The HTTP method to use for the request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Optional query parameters to filter or paginate the badges.
Path Parameters Path parameters required for the API endpoint.

Output

JSON

  • id - The unique identifier of the badge.
  • name - The name of the badge.
  • image_url - The URL of the badge image.
  • link_url - The URL the badge links to.
  • kind - The kind of badge (e.g., project or group badge).
  • created_at - The timestamp when the badge was created.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the group ID or URL-encoded path is correct and accessible by the authenticated user.
  • Verify that the authentication credentials are valid and have the necessary permissions to access group badges.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • If pagination parameters are used, ensure they are valid integers and within allowed ranges.

Links

Discussion