---
title: "Get badges for customer"
method: GET
path: "/api_gateway/v1/badges/customer/{customerId}"
---

# Get badges for customer

`GET /api_gateway/v1/badges/customer/{customerId}`

## Path parameters

- `customerId` string, required

## Query parameters

- `badgeType` 'AVAILABLE' | 'EARNED'
- `includeExpired` boolean
- `sortOn` string
- `groupId` string
- `lastEarnedOnDate` number, float
- `lastEarnEventDate` number, float

## Headers

- `X-CAP-CUSTOMER-IDENTIFIER` 'email' | 'mobile' | 'cardNumber' | 'externalId'

## Response `200`

200

- union
  - object
    - `data` object
      - `badges` object[]
        - `badgeMetaId` string
        - `orgId` integer
        - `name` string
        - `description` string
        - `startOn` integer
        - `expiresOn` integer
        - `images` object[]
          - `name` string
          - `fileSvcHandle` string
          - `url` string
          - `tag` string
        - `tags` unknown[]
          - unknown
        - `badgeGroupId` unknown
        - `badgeGroupName` unknown
        - `badgeRank` integer
        - `ownership` object
          - `restrictedToOwners` string[]
          - `claims` object[]
            - `ownerType` string
            - `referenceId` string
            - `isActive` boolean
        - `earnType` string
        - `benefits` object[]
          - `benefitType` string
          - `seriesId` integer
        - `customerConstraints` object[]
          - `constraintType` string
          - `referenceId` string
          - `durationType` string
          - `refreshRate` integer
          - `maxEarnLimit` integer
          - `cycleStatus` string
          - `startDate` integer
          - `endDate` integer
        - `badgeConstraints` object[]
          - `constraintType` string
          - `maxEarnLimit` integer
        - `earnedCount` unknown
        - `lastEarnedOnDate` unknown
        - `lastEarnEventDate` unknown
        - `customFields` object
        - `active` boolean
      - `pagination` object
        - `page` integer
        - `size` integer
        - `total` integer
        - `totalPages` integer
    - `errors` unknown[]
      - unknown
    - `warnings` unknown[]
      - unknown
  - object
    - `data` object
      - `badges` object[]
        - `badgeMetaId` string
        - `orgId` integer
        - `name` string
        - `description` string
        - `startOn` integer
        - `expiresOn` integer
        - `images` object[]
          - `name` string
          - `fileSvcHandle` string
          - `url` string
          - `tag` string
        - `tags` unknown[]
          - unknown
        - `badgeGroupId` unknown
        - `badgeGroupName` unknown
        - `badgeRank` integer
        - `ownership` object
          - `restrictedToOwners` string[]
          - `claims` object[]
            - `ownerType` string
            - `referenceId` string
            - `isActive` boolean
        - `earnType` string
        - `benefits` object[]
          - `benefitType` string
          - `seriesId` integer
        - `customerConstraints` object[]
          - `constraintType` string
          - `referenceId` string
          - `durationType` string
          - `refreshRate` integer
          - `maxEarnLimit` integer
          - `cycleStatus` string
          - `startDate` integer
          - `endDate` integer
        - `badgeConstraints` object[]
          - `constraintType` string
          - `maxEarnLimit` integer
        - `earnedCount` integer
        - `lastEarnedOnDate` number
        - `lastEarnEventDate` number
        - `customFields` object
        - `active` boolean
      - `pagination` object
        - `page` integer
        - `size` integer
        - `total` integer
        - `totalPages` integer
    - `errors` unknown[]
      - unknown
    - `warnings` unknown[]
      - unknown
  - object
    - `data` object
      - `badges` object[]
        - `badgeMetaId` string
        - `orgId` integer
        - `name` string
        - `description` string
        - `startOn` integer
        - `expiresOn` integer
        - `images` object[]
          - `name` string
          - `fileSvcHandle` string
          - `url` string
          - `tag` string
        - `badgeGroupId` string
        - `badgeGroupName` string
        - `badgeRank` integer
        - `ownership` object
          - `restrictedToOwners` string[]
          - `claims` object[]
            - `ownerType` string
            - `referenceId` string
            - `isActive` boolean
        - `earnType` string
        - `customerConstraints` object[]
          - `constraintType` string
          - `maxEarnLimit` integer
        - `badgeConstraints` unknown[]
          - unknown
        - `earnedCount` unknown
        - `customFields` object
          - `2024` string
          - `Date` string
          - `Category1` string
          - `Priority` string
        - `active` boolean
      - `pagination` object
        - `page` integer
        - `size` integer
        - `total` integer
        - `totalPages` integer
    - `errors` unknown[]
      - unknown
    - `warnings` unknown[]
      - unknown

---

[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)