Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get all customer badges

get/api_gateway/v1/badges/management/{customerId}

Path parameters

customerIdinteger required

Unique customer identifier

Query parameters

pagestring
sizestring
sortOn'EXPIRES_ON' | 'LAST_MODIFIED_DATE' | 'LAST_ISSUED_DATE' | 'LAST_EXPIRED_BADGE'

Sorting based on parameters

order'DESC' | 'ASC'

Sorting results based on ascending or descending order

namestring
badgeTypestring
actionstring
badgeStatustring
ownerstring
claimedBystring
startOnstring
expiresOnstring
startOnOperatorstring
endOnOperatorstring
groupIdstring
lastEarnEventDatenumber float

Date and time when a triggering event (transactional or behavioural) occurred, initiating the badge earning. Time format: Epoch format (UNIX timestamp in milliseconds).

lastEarnedOnDatenumber float

Date and time when the badge was awarded to the customer. Time format: Epoch format (UNIX timestamp in milliseconds).

Response

200

OR
OR
OR
OR
OR
OR
OR

Example response

{
  "data": {
    "customerBadges": [
      {
        "name": "1st Badge",
        "description": "Make 5 transactions",
        "badgeMetaId": "678dea89b98628326d60f1e9",
        "badgeType": "ISSUE_EARN",
        "badgeRank": 3,
        "createdOn": 1737353865.548,
        "lastUpdatedOn": 1741944459.724,
        "images": [
          {
            "name": "Issued",
            "fileSvcHandle": "qwer-8634-8938",
            "url": "https://firebasestorage.googleapis.com/v0/b/createbadges.appspot.com/o/images%2Fsuccess1.jpg?alt=media&token=66b2f0bc-9c55-4e33-a5e9-c6be96d94f2d",
            "tag": "EARNED"
          }
        ],
        "badgeStatus": "EXPIRED",
        "startsOn": 1737440146,
        "expiresOn": 1742537746,
        "ownership": {
          "restrictedToOwners": [
            "Loyalty_Promotion"
          ],
          "claims": [
            {
              "ownerType": "Rewards_Catalog",
              "referenceId": "123",
              "isActive": true
            }
          ]
        },
        "active": true
      }
    ],
    "pagination": {
      "size": 5,
      "total": 5,
      "totalPages": 1
    }
  }
}