GitLab API icon

GitLab API

Gitlab

Actions1062

Badges → getApiV4ProjectsIdBadges

AI-generated

Summary

Retrieve all badges of a specific GitLab project by its ID or URL-encoded path, supporting pagination and optional filtering by badge name.

Inputs

  • id (required) — The ID or URL-encoded path of the GitLab project whose badges you want to retrieve.
  • page — The page number for paginated results, defaulting to 1 if not specified.
  • per_page — The number of badge items to retrieve per page, defaulting to 20 if not specified.
  • name — Optional filter to return badges matching the specified name.
  • skipAuthentication — Boolean flag to skip authentication for the request (default is false).
  • baseUrl — Base URL of the GitLab instance, defaulting to https://gitlab.com.
  • method — HTTP method to use for the request; defaults to GET.

Output shape

a list of badge objects associated with the specified project.

The response supports pagination controlled by the 'page' and 'per_page' query parameters. Filtering by badge name is optional and exact matching is expected. The operation requires authentication unless explicitly skipped.

Examples

Example 1: Retrieve first page of badges for project 'my-group/my-project' with default page size.

Set path parameter 'id' to 'my-group/my-project', leave other query parameters empty or default.

Links

Discussion