Get all badges

This API is used to retrieve all badges for the org.

👍

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic authentication
  • Default access group

Resource information

URI/api_gateway/v1/badges/badgeMeta
HTTP methodGET
Pagination supportedYes
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta?status=LIVE,UPCOMING

Request query parameters

ParameterTypeDescription
statusEnumThe badge can have three statuses upon creation.
Supported values: LIVE, UPCOMING, ENDED/EXPIRED.
LIVE: The badges which are in live state and can be earned.
UPCOMING: The badges which are upcoming on a further date.
EXPIRED/ENDED: The badges which have expired and cannot be earned.
earnTypeEnumThe method the brand can issue the badge.
Supported values: EARN, ISSUE EARN.
Earn: The selected customers are enrolled for the badge and upon fulfillment of the earn condition, the badge is issued.
Issue Earn: The Badges are issued directly to the customer who fulfills the earn condition.
actionEnumIndicates if the badge is active or not. Supported values: Activated and Deactivated
badgeTypeEnumThe type of badge to display. Supported values: ISSUE_EARN, EARN.
ownerEnumThe module for which the badge is being created.
Supported values: LOYALTY/REFERRAL_CAMPAIGNS/JOURNEYS/AUDIENCE_CAMPAIGNS/
REWARDS_CATALOG/ GOODWILL_MODULE/ MILESTONES
claimedByStringModules that have claimed the badge. Example: LOYALTY/REFERRAL_CAMPAIGNS/JOURNEYS/AUDIENCE_CAMPAIGNS/REWARDS_CATALOG/ GOODWILL_MODULE/ MILESTONES
unclaimedBooleanA boolean variable to flag unclaimed badges. Default: False.
nameStringName of the badge.
limitIntegerNumber of results. For example, number 10 retrieves the first 10 rows of the query results. Default value: 10.
sortOnEnumThe supported values are: ID/NAME/START_DATE. Default value: ID.
startOnDate TimeFilter badges based on start time. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ. Example: 2023-02-16T00:00:00Z
expiresOnDate TimeFilter based on expiry of the badge. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ. Example: 2024-01-01T00:00:00Z
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/badgeMeta?status=LIVE,UPCOMINGstartOn=2023-02-16T00:00:00Z&expiresOn=2024-01-01T00:00:00Z

Response parameters

ParameterData TypeDescription
idStringUnique identifier for the badge.
orgIdIntegerOrganization ID associated with the badge.
nameStringName of the badge.
descriptionStringDescription of the badge.
startOnDateStart time of the badge.
expiresOnDateExpiration time of the badge.
statusEnumStatus of the badge. Supported values: UPCOMING, LIVE, ENDED)
tagsObjectList of tags associated with the badge.
nameStringName of the tag.
valueStringValue of the tag.
earnTypeStringType of earning associated with the badge
earnedBadgeExpiryObjectDetails of earned badge expiry
expiryTypeEnumType of expiry, supported values: RELATIVE,ABSOLUTE,NEVER
Relative expiry is based on when the badge was issued.
Absolute expiry is based on the fixed date from the badge issual.
Never means, the badges will never expiry after issual.
relativeExpirytypeStringType of relative expiry. Supported values: DAYS,WEEKS, MONTHS
valueIntegerValue indicating the duration of expiry
expireWithBadgeMetaBooleanIndicates if expiry is associated with badge meta
ownershipObjectOwnership details of the badge
restrictedToOwnersStringList of owners restricted to the badge
claimsObjectList of claims associated with the badge
badgeMetaIdStringBadge metadata ID
ownerTypeEnumThe module for which the badge is being claimed.
Supported values: LOYALTY/REFERRAL_CAMPAIGNS/JOURNEYS/AUDIENCE_CAMPAIGNS/
REWARDS_CATALOG/ GOODWILL_MODULE/ MILESTONES.
referenceIdStringReference ID associated with the claim.
benefitsObjectList of benefits associated with the badge.
benefitTypeStringType of benefit, these can be of the form of coupons, points etc.
seriesIdIntegerSeries ID for the benefit
programIdIntegerProgram ID for loyalty points
promotionIdIntegerPromotion ID for loyalty points
allocationStrategyIdIntegerAllocation strategy ID
expirationStrategyIdIntegerExpiration strategy ID
defaultTillIdIntegerDefault till ID
issuedCountIntegerCount of issued badges
earnedCountIntegerCount of earned badges
createdOnDateCreation timestamp
createdByIntegerID of the user who created the badge
lastUpdatedOnDateLast update timestamp
lastUpdatedByIntegerID of the user who last updated the badge
customFieldsObjectList of custom fields.
customFieldNameStringName of the custom field.
customFieldValueStringValue of the custom field.
activeBooleanIndicates if the badge is active
{
    "data": {
        "metaBasicDetails": [
            {
                "id": "65829487d5d6136a224ea350",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212ac12345",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 4,
                "createdOn": 1703056519.502000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707223044.446000000,
                "lastUpdatedBy": 75069206,
                "customFields": {
                    "CF1": "CF1",
                    "CF2 INTEGER": "1",
                    "CF3 boolean": "true",
                    "CF3 date": "2001-01-18T09:09:09Z",
                    "CF31 date": ""
                },
                "active": false
            },
            {
                "id": "6582947dd5d6136a224ea34f",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212ac1234",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056509.447000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707223054.850000000,
                "lastUpdatedBy": 75069206,
                "customFields": null,
                "active": false
            },
            {
                "id": "6582946fd5d6136a224ea34e",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212ac123",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056495.721000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707223058.245000000,
                "lastUpdatedBy": 75069206,
                "customFields": null,
                "active": false
            },
            {
                "id": "6582945fd5d6136a224ea34d",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212ac12",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056479.734000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1703056479.734000000,
                "lastUpdatedBy": 75097962,
                "customFields": null,
                "active": false
            },
            {
                "id": "65829449d5d6136a224ea34c",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212ac1",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056457.799000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707223062.347000000,
                "lastUpdatedBy": 75069206,
                "customFields": null,
                "active": false
            },
            {
                "id": "6582943cd5d6136a224ea34b",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212ac",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056444.329000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707223066.544000000,
                "lastUpdatedBy": 75069206,
                "customFields": null,
                "active": false
            },
            {
                "id": "6582938ed5d6136a224ea34a",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212ac",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056270.175000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1703056270.175000000,
                "lastUpdatedBy": 75097962,
                "customFields": null,
                "active": false
            },
            {
                "id": "6582937ed5d6136a224ea349",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212a",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056254.913000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707223073.242000000,
                "lastUpdatedBy": 75069206,
                "customFields": null,
                "active": false
            },
            {
                "id": "65829375d5d6136a224ea348",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212a",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056245.845000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1703056245.845000000,
                "lastUpdatedBy": 75097962,
                "customFields": null,
                "active": false
            },
            {
                "id": "65829345d5d6136a224ea347",
                "orgId": 100606,
                "name": "demo testkerl2n26df13212",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string",
                            "isActive": true
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1703056197.093000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707223125.545000000,
                "lastUpdatedBy": 75069206,
                "customFields": null,
                "active": false
            }
        ],
        "pagination": {
            "page": 0,
            "size": 10,
            "total": 44,
            "totalPages": 5
        }
    },
    "errors": [],
    "warnings": []
}
{
    "data": {
        "metaBasicDetails": [
            {
                "id": "657fc16ed5d6136a224e9caa",
                "orgId": 100458,
                "name": "demo jmm",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1702871406.946000000,
                "createdBy": 75086856,
                "lastUpdatedOn": 1702871406.946000000,
                "lastUpdatedBy": 75086856,
                "active": true
            },
            {
                "id": "657c19a7d5d6136a224e9475",
                "orgId": 100458,
                "name": "demo testkl226df",
                "description": "string",
                "startOn": 1699998660.192000000,
                "expiresOn": 1796311177.192000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "string",
                        "fileSvcHandle": "string",
                        "url": "string",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "string"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "ABSOLUTE",
                    "type": "WITH_BADGE_META",
                    "expiresOn": 1730647177.192000000,
                    "expireWithBadgeMeta": true
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "string"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "COUPON",
                        "seriesId": 1
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1702631847.007000000,
                "createdBy": 75086856,
                "lastUpdatedOn": 1702631847.007000000,
                "lastUpdatedBy": 75086856,
                "active": true
            },
            {
                "id": "65312d0fb3cda7078c7c689e",
                "orgId": 100458,
                "name": "Referral Champion",
                "description": "Refer 3 friends, win the badge and 200 points!",
                "startOn": 1697653800000.000000000,
                "expiresOn": 1706571000000.000000000,
                "status": "UPCOMING",
                "images": [
                    {
                        "name": "unissued",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://firebasestorage.googleapis.com/v0/b/createbadges.appspot.com/o/images%2Fdownload%20(2).jpeg?alt=media&token=fcb02db9-39bc-453f-8828-316664c95917",
                        "tag": "UN_EARNED"
                    },
                    {
                        "name": "in prog",
                        "fileSvcHandle": "48e4aaa2-da47-41e2-af60-a2c17a2d66ab",
                        "url": "https://storage.crm.eu.content-cdn.io/fs.capillary.eu/incentives_assets/badges/images/100458/65312d0fb3cda7078c7c689e_IN_PROGRESS_Ax6nSkq2.png",
                        "tag": "IN_PROGRESS"
                    }
                ],
                "tags": [
                    {
                        "name": null,
                        "value": "test"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "RELATIVE",
                    "relativeExpirytype": "WEEKS",
                    "value": 2
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "xyz"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "LOYALTY_PROMOTION",
                        "promotionId": 6778,
                        "promotionName": "name",
                        "promoIdentifier": "identifier",
                        "programId": 123
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1697721615.755000000,
                "createdBy": 75078478,
                "lastUpdatedOn": 1698166221.143000000,
                "lastUpdatedBy": 75058287,
                "active": true
            },
            {
                "id": "6531124fb3cda7078c7c689d",
                "orgId": 100458,
                "name": "test19",
                "description": "test19",
                "startOn": 1697711400000.000000000,
                "expiresOn": 1697797800000.000000000,
                "status": "UPCOMING",
                "images": [
                    {
                        "name": "",
                        "fileSvcHandle": "6e793020-7704-4c42-89e8-f916afe4b2c1",
                        "url": "https://storage.crm.eu.content-cdn.io/fs.capillary.eu/incentives_assets/badges/images/100458/6531124fb3cda7078c7c689d_UN_EARNED_ZH0Y1RtG.png",
                        "tag": "UN_EARNED"
                    }
                ],
                "tags": [],
                "earnType": "ISSUE_EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "RELATIVE",
                    "relativeExpirytype": "WEEKS",
                    "value": 2
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "xyz"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "LOYALTY_PROMOTION",
                        "promotionId": 6778,
                        "promotionName": "name",
                        "promoIdentifier": "identifier",
                        "programId": 123
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1697714767.054000000,
                "createdBy": 75078478,
                "lastUpdatedOn": 1701881894.072000000,
                "lastUpdatedBy": 75069206,
                "active": true
            },
            {
                "id": "652fc3ae2aa6a339209b359d",
                "orgId": 100458,
                "name": "sj2",
                "description": "sj2",
                "startOn": 1697648867.000000000,
                "expiresOn": 1726235957.000000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "unearned1",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "UN_EARNED"
                    },
                    {
                        "name": "unearned",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "IN_PROGRESS"
                    }
                ],
                "tags": [
                    {
                        "name": "key",
                        "value": "value"
                    }
                ],
                "earnType": null,
                "earnedBadgeExpiry": {
                    "expiryType": "RELATIVE",
                    "relativeExpirytype": "WEEKS",
                    "value": 2
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "xyz"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "LOYALTY_POINTS",
                        "programId": 791,
                        "promotionId": 80332,
                        "allocationStrategyId": 10443,
                        "expirationStrategyId": 7730,
                        "defaultTillId": null
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1697629102.887000000,
                "createdBy": 75078478,
                "lastUpdatedOn": 1700805185.097000000,
                "lastUpdatedBy": 75069206,
                "active": false
            },
            {
                "id": "652fc32a2aa6a339209b359c",
                "orgId": 100458,
                "name": "testbadge67",
                "description": "testbadge",
                "startOn": 1698586638.000000000,
                "expiresOn": 1726235957.000000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "unearned1",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "UN_EARNED"
                    },
                    {
                        "name": "unearned",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "IN_PROGRESS"
                    }
                ],
                "tags": [
                    {
                        "name": "key",
                        "value": "value"
                    }
                ],
                "earnType": "ISSUE_EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "RELATIVE",
                    "relativeExpirytype": "WEEKS",
                    "value": 2
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "xyz"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "LOYALTY_POINTS",
                        "programId": 791,
                        "promotionId": 80332,
                        "allocationStrategyId": 10443,
                        "expirationStrategyId": 7730,
                        "defaultTillId": null
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1697628970.378000000,
                "createdBy": 75078478,
                "lastUpdatedOn": 1700805189.402000000,
                "lastUpdatedBy": 75069206,
                "active": false
            },
            {
                "id": "652f9df02aa6a339209b359b",
                "orgId": 100458,
                "name": "sj1",
                "description": "sj1",
                "startOn": 1697648867.000000000,
                "expiresOn": 1726235957.000000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "unearned1",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "UN_EARNED"
                    },
                    {
                        "name": "unearned",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "IN_PROGRESS"
                    }
                ],
                "tags": [
                    {
                        "name": "key",
                        "value": "value"
                    }
                ],
                "earnType": null,
                "earnedBadgeExpiry": {
                    "expiryType": "RELATIVE",
                    "relativeExpirytype": "WEEKS",
                    "value": 2
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "xyz"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "LOYALTY_POINTS",
                        "programId": 791,
                        "promotionId": 80332,
                        "allocationStrategyId": 10443,
                        "expirationStrategyId": 7730,
                        "defaultTillId": null
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1697619440.882000000,
                "createdBy": 75078478,
                "lastUpdatedOn": 1700805192.890000000,
                "lastUpdatedBy": 75069206,
                "active": false
            },
            {
                "id": "652f72af2aa6a339209b359a",
                "orgId": 100458,
                "name": "testbadge1",
                "description": "testbadge1",
                "startOn": 1697616467.000000000,
                "expiresOn": 1726235957.000000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "unearned1",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "UN_EARNED"
                    },
                    {
                        "name": "unearned",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "IN_PROGRESS"
                    }
                ],
                "tags": [
                    {
                        "name": "key",
                        "value": "value"
                    }
                ],
                "earnType": null,
                "earnedBadgeExpiry": {
                    "expiryType": "RELATIVE",
                    "relativeExpirytype": "WEEKS",
                    "value": 2
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "xyz"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "LOYALTY_POINTS",
                        "programId": 791,
                        "promotionId": 80332,
                        "allocationStrategyId": 10443,
                        "expirationStrategyId": 7730,
                        "defaultTillId": null
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1697608367.083000000,
                "createdBy": 75078478,
                "lastUpdatedOn": 1697608367.083000000,
                "lastUpdatedBy": 75078478,
                "active": true
            },
            {
                "id": "652f6a482aa6a339209b3599",
                "orgId": 100458,
                "name": "testbadge6",
                "description": "testbadge3",
                "startOn": 1697705643.000000000,
                "expiresOn": 1726235957.000000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "unearned1",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "UN_EARNED"
                    },
                    {
                        "name": "unearned",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "IN_PROGRESS"
                    }
                ],
                "tags": [
                    {
                        "name": "key",
                        "value": "value"
                    }
                ],
                "earnType": "EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "RELATIVE",
                    "relativeExpirytype": "WEEKS",
                    "value": 2
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "xyz"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "LOYALTY_POINTS",
                        "programId": 791,
                        "promotionId": 80332,
                        "allocationStrategyId": 10443,
                        "expirationStrategyId": 7730,
                        "defaultTillId": null
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1697606216.422000000,
                "createdBy": 75078478,
                "lastUpdatedOn": 1697606216.422000000,
                "lastUpdatedBy": 75078478,
                "active": true
            },
            {
                "id": "652f6a382aa6a339209b3598",
                "orgId": 100458,
                "name": "testbadge5",
                "description": "testbadge3",
                "startOn": 1697705643.000000000,
                "expiresOn": 1726235957.000000000,
                "status": "LIVE",
                "images": [
                    {
                        "name": "unearned1",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "UN_EARNED"
                    },
                    {
                        "name": "unearned",
                        "fileSvcHandle": "qwer-8634-8938",
                        "url": "https://badge.url",
                        "tag": "IN_PROGRESS"
                    }
                ],
                "tags": [
                    {
                        "name": "key",
                        "value": "value"
                    }
                ],
                "earnType": "ISSUE_EARN",
                "earnedBadgeExpiry": {
                    "expiryType": "RELATIVE",
                    "relativeExpirytype": "WEEKS",
                    "value": 2
                },
                "ownership": {
                    "restrictedToOwners": [
                        "Loyalty"
                    ],
                    "claims": [
                        {
                            "ownerType": "Loyalty",
                            "referenceId": "xyz"
                        }
                    ]
                },
                "benefits": [
                    {
                        "benefitType": "LOYALTY_POINTS",
                        "programId": 791,
                        "promotionId": 80332,
                        "allocationStrategyId": 10443,
                        "expirationStrategyId": 7730,
                        "defaultTillId": null
                    }
                ],
                "issuedCount": 0,
                "earnedCount": 0,
                "createdOn": 1697606200.072000000,
                "createdBy": 75078478,
                "lastUpdatedOn": 1697606200.072000000,
                "lastUpdatedBy": 75078478,
                "active": true
            }
        ],
        "pagination": {
            "page": 0,
            "size": 10,
            "total": 14,
            "totalPages": 2
        }
    },
    "errors": [],
    "warnings": []
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!