---
title: "GET /components/v1/badge"
method: GET
path: "/components/v1/badge"
tags: ["Badges"]
---

# GET /components/v1/badge

`GET /components/v1/badge`

Retrieves a list of all badges.

## Response `200`

Badges retrieved successfully.

- GetAllBadgesResponse
  - `getAllBadgesResponse` object[]
    - `id` string — Badge ID.
    - `name` string — Badge name.
    - `publisherBadgeId` string — Badge ID that you defined.
    - `type` 'emblem' | 'ribbon' — Badge type.
    - `badgeImageUrl` string, url — Badge image URL. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL.
    - `text` string — Text displayed on ribbon badge. Only present for ribbon badges.
    - `backgroundColor` object — Background color details. Only present for ribbon badges.
      - `colorOne` string — Primary color for the background.
      - `colorTwo` string — Secondary color for the gradient background.
      - `gradientDirection` 'to top' | 'to bottom' | 'to left' | 'to right' | 'to top left' | 'to top right' | 'to bottom left' | 'to bottom right' — Direction of the gradient.
    - `textColor` object — Text color. Only present for ribbon badges.
      - `colorOne` string — Text color in hex format.

---

[API](https://skmtc.net/appcharge/apis/grant-award.md) · [All operations](https://skmtc.net/appcharge/apis/grant-award/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/appcharge/grant-award/versions/b4f6759240d5/schema)