v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get all badges

get/api_gateway/v1/badges/badgeMeta

Query parameters

status'LIVE' | 'UPCOMING' | 'EXPIRED'

The status of the badge.

earnTypestring

EARN, ISSUE_EARN

actionstring

ACTIVATED, DE_ACTIVATED

ownerstring

Loyalty, Milestones, Journeys, Audience_Campaigns, Referral_Campaigns

claimedBystring

Loyalty, Milestones, Journeys, Audience_Campaigns, Referral_Campaigns

unclaimedboolean

true. false

namestring

Name of the badge.

badgeType'issue_earn' | 'earn'

The type of badge to display.

startOnstring date

Filter based on start date of the badge

expiresOnstring date

Filter based on expiry of the badge.

Response

200

Example response

{
  "data": {
    "metaBasicDetails": [
      {
        "id": "66868a683778145cbb91193a",
        "orgId": 100458,
        "name": "Badge Issue earn27",
        "badgeRank": 3,
        "description": "Make 5 transactions",
        "startOn": 1721520000,
        "expiresOn": 1726804000,
        "status": "UPCOMING",
        "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"
          }
        ],
        "earnType": "ISSUE_EARN",
        "earnedBadgeExpiry": {
          "expiryType": "RELATIVE",
          "relativeExpirytype": "WEEKS",
          "value": 2
        },
        "ownership": {
          "restrictedToOwners": [
            "Rewards_Catalog"
          ],
          "claims": [
            {
              "ownerType": "Historical_Import",
              "referenceId": "123",
              "isActive": true
            }
          ]
        },
        "createdOn": 1720093288.334,
        "createdBy": 75130850,
        "lastUpdatedOn": 1720093422.07,
        "lastUpdatedBy": 75130850,
        "active": true
      }
    ],
    "pagination": {
      "size": 10,
      "total": 122,
      "totalPages": 13
    }
  }
}