Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get individual badge details of a customer

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

Path parameters

customerIdstring required

Unique customer identifier

badgeIdstring required

Unique ID of the badge

Query parameters

includeStatisticsboolean

Set true to retrieve customer and badge constraints, and earn and issue badge details.

Response

200

OR
OR
OR
OR
OR

Example response

{
  "data": {
    "id": "662724bb8fe258516a88fde2",
    "name": "OGBadge2",
    "description": "Moving window",
    "createdOn": 1713841339.861,
    "lastUpdatedOn": 1713841339.861,
    "startsOn": 1707523237.192,
    "expiresOn": 1715299237.192,
    "action": "ACTIVATED",
    "badgeType": "EARN",
    "badgeStatus": "EXPIRED",
    "owner": [
      "Loyalty"
    ],
    "images": [
      {
        "name": "string",
        "fileSvcHandle": "string",
        "url": "string",
        "tag": "UN_EARNED"
      }
    ],
    "earnExpiry": {
      "expiryType": "RELATIVE",
      "relativeExpirytype": "DAYS",
      "value": 2
    },
    "issueExpiry": {
      "expiryType": "RELATIVE",
      "relativeExpirytype": "DAYS",
      "value": 2
    },
    "customerConstraints": [
      {
        "constraintLevel": "CUSTOMER",
        "constraintType": "OVERALL",
        "maxEarnLimit": 100
      }
    ],
    "badgeConstraints": [
      {
        "constraintLevel": "BADGE",
        "constraintType": "OVERALL",
        "maxEarnLimit": 1000
      }
    ]
  }
}