---
title: "Get badge by ID"
method: GET
path: "/api_gateway/v1/badges/badgeMeta/{badgeId}"
---

# Get badge by ID

`GET /api_gateway/v1/badges/badgeMeta/{badgeId}`

## Path parameters

- `badgeId` string, required

## Query parameters

- `status` 'UPCOMING' | 'LIVE' | 'EXPIRED'

## Response `200`

200

- union
  - object
    - `data` object
      - `id` string
      - `badgeNumericId` unknown
      - `orgId` integer
      - `name` string
      - `description` string
      - `startOn` integer
      - `expiresOn` integer
      - `earnedBadgeExpiry` object
        - `expiryType` string
        - `type` string
        - `expiresOn` unknown
        - `expireWithBadgeMeta` boolean
      - `issuedBadgeExpiry` unknown
      - `images` unknown[]
        - unknown
      - `ownership` object
        - `restrictedToOwners` string[]
        - `claims` unknown[]
          - unknown
      - `customerConstraints` object[]
        - `constraintType` string
        - `referenceId` string
        - `durationType` string
        - `refreshRate` integer
        - `maxEarnLimit` integer
        - `cycleStatus` string
        - `startDate` integer
        - `endDate` integer
        - `currentCycle` object
          - `startDate` number
          - `endDate` number
      - `badgeConstraints` object[]
        - `constraintType` string
        - `referenceId` string
        - `durationType` string
        - `refreshRate` integer
        - `maxEarnLimit` integer
        - `startDate` integer
        - `endDate` integer
        - `cycleStatus` string
        - `currentCycle` object
          - `startDate` number
          - `endDate` number
      - `badgeGroupId` unknown
      - `badgeRank` integer
      - `earnType` string
      - `issuedCount` integer
      - `earnedCount` integer
      - `status` string
      - `createdOn` number
      - `createdBy` integer
      - `lastUpdatedOn` number
      - `lastUpdatedBy` integer
      - `customFields` object
      - `active` boolean
    - `errors` unknown
    - `warnings` unknown
  - object
    - `data` object
      - `id` string
      - `badgeNumericId` unknown
      - `orgId` integer
      - `name` string
      - `description` string
      - `startOn` number
      - `expiresOn` number
      - `earnedBadgeExpiry` object
        - `expiryType` string
        - `relativeExpirytype` string
        - `value` integer
      - `issuedBadgeExpiry` object
        - `expiryType` string
        - `relativeExpirytype` string
        - `value` integer
      - `images` object[]
        - `name` string
        - `fileSvcHandle` string
        - `url` string
        - `tag` string
      - `ownership` object
        - `restrictedToOwners` string[]
        - `claims` unknown[]
          - unknown
      - `customerConstraints` object[]
        - `constraintType` string
        - `maxEarnLimit` integer
      - `badgeConstraints` object[]
        - `constraintType` string
        - `maxEarnLimit` integer
      - `badgeGroupId` unknown
      - `badgeRank` unknown
      - `earnType` string
      - `issuedCount` integer
      - `earnedCount` integer
      - `status` string
      - `createdOn` number
      - `createdBy` integer
      - `lastUpdatedOn` number
      - `lastUpdatedBy` integer
      - `customFields` object
      - `active` boolean
    - `errors` unknown
    - `warnings` unknown
  - object
    - `data` object
      - `id` string
      - `badgeNumericId` unknown
      - `orgId` integer
      - `name` string
      - `description` string
      - `startOn` integer
      - `expiresOn` integer
      - `earnedBadgeExpiry` object
        - `expiryType` string
        - `type` string
        - `expiresOn` unknown
        - `expireWithBadgeMeta` boolean
      - `issuedBadgeExpiry` unknown
      - `images` unknown[]
        - unknown
      - `ownership` object
        - `restrictedToOwners` string[]
        - `claims` unknown[]
          - unknown
      - `customerConstraints` object[]
        - `constraintType` string
        - `referenceId` string
        - `durationType` string
        - `refreshRate` integer
        - `maxEarnLimit` integer
        - `cycleStatus` string
        - `startDate` integer
        - `endDate` integer
        - `currentCycle` object
          - `startDate` number
          - `endDate` number
      - `badgeConstraints` object[]
        - `constraintType` string
        - `referenceId` string
        - `durationType` string
        - `refreshRate` integer
        - `maxEarnLimit` integer
        - `startDate` integer
        - `endDate` integer
        - `cycleStatus` string
        - `currentCycle` object
          - `startDate` number
          - `endDate` number
      - `badgeGroupId` unknown
      - `badgeRank` integer
      - `earnType` string
      - `issuedCount` integer
      - `earnedCount` integer
      - `status` string
      - `createdOn` number
      - `createdBy` integer
      - `lastUpdatedOn` number
      - `lastUpdatedBy` integer
      - `customFields` object
      - `active` boolean
    - `errors` unknown
    - `warnings` unknown
  - object
    - `data` object
      - `id` string
      - `badgeNumericId` unknown
      - `orgId` integer
      - `name` string
      - `description` string
      - `startOn` number
      - `expiresOn` number
      - `earnedBadgeExpiry` object
        - `expiryType` string
        - `relativeExpirytype` string
        - `value` integer
      - `issuedBadgeExpiry` object
        - `expiryType` string
        - `relativeExpirytype` string
        - `value` integer
      - `images` object[]
        - `name` string
        - `fileSvcHandle` string
        - `url` string
        - `tag` string
      - `ownership` object
        - `restrictedToOwners` string[]
        - `claims` unknown[]
          - unknown
      - `customerConstraints` object[]
        - `constraintType` string
        - `maxEarnLimit` integer
      - `badgeConstraints` object[]
        - `constraintType` string
        - `maxEarnLimit` integer
      - `badgeGroupId` unknown
      - `badgeRank` unknown
      - `earnType` string
      - `status` string
      - `createdOn` number
      - `createdBy` integer
      - `lastUpdatedOn` number
      - `lastUpdatedBy` integer
      - `customFields` object
      - `active` boolean
    - `errors` unknown
    - `warnings` unknown

## Other responses

- `404` — 404

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)