Time	Status	User Agent
Retrieving recent requests…

This API allows you to retrieve details of individual badges for a specific customer (Explode API).

For example: A User has completed 1000 steps and has earned a badge for achieving the goal. Using this API, the user can get information of a specific badge he has earned.

👍
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 .

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/v1/badges/management/919999999994/badge/693696bdcebb9648d89735b3?includeStatistics=true' \
--header 'Authorization: Basic bWFkaMjU2YQ==' \
--header 'Cookie: _cfuvid=LbgLgMATQVG7rxgU6obNtuTjuntKzGkHg15XluHdUPI-1768984490920-0.0.1.1-604800000'

Prerequisites

Authentication: Basic or OAuth authentication
Default access group

Resource information


URI	api_gateway/v1/badges/management/`{customerId}`/badge/`{badgeId}`
HTTP Method	GET
Pagination	No
Batch support	No
Rate limit information	None

Headers

To retrieve customers based on their email ID, mobile number, external ID or card number pass the X-CAP-CUSTOMER-IDENTIFIER.
The supported values are:

email
mobile
externalId
cardNumber

Example: X-CAP-CUSTOMER-IDENTIFIER: email

API endpoint example

Endpoint: https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/management/381921157/badge/65ae47103c2f9e39583095a4

Endpoint using the X-CAP-CUSTOMER-IDENTIFIER: email header: https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/management/[email protected]/badge/6656aa8846bd1129b0ae1241?includeStatistics=true

Request path parameters

Parameter Name	Data Type	Description
customerId*	String	Unique ID of the customer.
badgeId*	String	Unique ID of the badge.

Request query parameter

Parameter Name	Data type	Description
includeStatistics	Boolean	Set true to retrieve customer and badge constraints, and earn and issue badge details.

Example response

{
    "data": {
        "id": "693696bdcebb9648d89735b3",
        "name": "Badge Issueds_Test6 ",
        "description": "Make 5 transactions",
        "createdOn": 1765185213.630000000,
        "createdOnISO": "2025-12-08T09:13:33Z",
        "lastUpdatedOn": 1765185213.630000000,
        "lastUpdatedOnISO": "2025-12-08T09:13:33Z",
        "startsOn": 1765178896000.000000000,
        "startsOnISO": "+57906-04-18T07:06:40Z",
        "expiresOn": 1796275142001.000000000,
        "expiresOnISO": "+58891-09-10T13:13:21Z",
        "action": "ACTIVATED",
        "badgeType": "ISSUE_EARN",
        "badgeStatus": "UPCOMING",
        "owner": [
            "Loyalty_Promotion",
            "Loyalty",
            "Historical_Import",
            "Milestones",
            "Rewards_Catalog",
            "Journeys",
            "Referral_Campaigns",
            "Audience_Campaigns",
            "Goodwill_Module"
        ],
        "claimedBy": [],
        "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"
            }
        ],
        "earnExpiry": {
            "expiryType": "RELATIVE",
            "relativeExpirytype": "WEEKS",
            "value": 2
        },
        "issueExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "FIXED_DATE",
            "expiresOn": 1796277042000.000000000,
            "expiresOnISO": "+58891-10-02T13:00:00Z",
            "expireWithBadgeMeta": false
        },
        "tags": [],
        "badgeRank": 3,
        "customerConstraints": [
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "FIXED_WINDOW",
                "rollType": null,
                "refreshRate": 3,
                "durationType": "DAYS",
                "cycleStatus": "UPCOMING",
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 2,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": null,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": "e6791ec9-e92f-34af-bdc3-be2607fdf82c",
                "rollingWindowLimits": null
            }
        ],
        "badgeConstraints": [
            {
                "constraintLevel": "BADGE",
                "constraintType": "OVERALL",
                "rollType": null,
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 10000,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            },
            {
                "constraintLevel": "BADGE",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "WEEKS",
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": 1,
                "maxEarnLimit": 3000,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            },
            {
                "constraintLevel": "BADGE",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "DAYS",
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": 1,
                "maxEarnLimit": 300,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            }
        ],
        "issualDetails": {
            "issuedCount": 0,
            "issuals": []
        },
        "earnDetails": {
            "earnCount": 0,
            "earns": []
        },
        "activeEarnedCount": 0,
        "lastEarnedOnISO": null,
        "customFields": {
            "CF 04": "1234",
            "CF 05": "1234",
            "Badge use": "uses",
            "CF31 date": "false",
            "CF07": "true",
            "CF 09": "null",
            "CF 177": "0",
            "Test CF 01": "0",
            "Test CF": "null"
        },
        "lastEarnedOnDateISO": null,
        "lastEarnEventDateISO": null
    },
    "errors": [],
    "warnings": []
}

Fixed window with includeStatistics=false
{
    "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"
        ],
        "claimedBy": [],
        "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",
                "rollType": null,
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 100,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null
            }
        ],
        "badgeConstraints": [
            {
                "constraintLevel": "BADGE",
                "constraintType": "OVERALL",
                "rollType": null,
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 1000,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null
            }
        ],
        "issualDetails": {
            "issuedCount": 0,
            "issuals": []
        },
        "earnDetails": {
            "earnCount": 0,
            "earns": []
        },
        "activeEarnedCount": 0,
        "customFields": {}
    },
    "errors": [],
    "warnings": []
}

{
    "data": {
        "id": "662749408fe258516a88fe89",
        "name": "BADGE123",
        "description": "Purchase 5 pet products in 3 months and get a pet grooming voucher",
        "createdOn": 1713850688.811,
        "lastUpdatedOn": 1713850688.811,
        "startsOn": 1716803487,
        "expiresOn": 1726804000,
        "action": "DE_ACTIVATED",
        "badgeType": "EARN",
        "badgeStatus": "LIVE",
        "owner": [
            "Milestones",
            "Loyalty"
        ],
        "claimedBy": [],
        "images": [],
        "earnExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "WITH_BADGE_META",
            "expiresOn": null,
            "expireWithBadgeMeta": true
        },
        "badgeRank": 1,
        "customerConstraints": [
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "FIXED_WINDOW",
                "rollType": null,
                "refreshRate": 3,
                "durationType": "DAYS",
                "cycleStatus": "ACTIVE",
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 1,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": {
                    "startDate": 1719900534.389096,
                    "endDate": 1720073334.389096
                },
                "fixedWindowReferenceId": "e6791ec9-e92f-34af-bdc3-be2607fdf82c"
            }
        ],
        "badgeConstraints": [
            {
                "constraintLevel": "BADGE",
                "constraintType": "FIXED_WINDOW",
                "rollType": null,
                "refreshRate": 3,
                "durationType": "DAYS",
                "cycleStatus": "ACTIVE",
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 2,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": {
                    "startDate": 1719900534.389096,
                    "endDate": 1720073334.389096
                },
                "fixedWindowReferenceId": "a1350b49-eb8e-3500-9e43-01f5493c91c1"
            }
        ],
        "issualDetails": {
            "issuedCount": 0,
            "issuals": []
        },
        "earnDetails": {
            "earnCount": 0,
            "earns": []
        },
        "activeEarnedCount": 0,
        "customFields": {}
    },
    "errors": [],
    "warnings": []
}

{
    "data": {
        "id": "662749408fe258516a88fe89",
        "name": "BADGE123",
        "description": "Purchase 5 pet products in 3 months and get a pet grooming voucher",
        "createdOn": 1713850688.811,
        "lastUpdatedOn": 1713850688.811,
        "startsOn": 1716803487,
        "expiresOn": 1726804000,
        "action": "DE_ACTIVATED",
        "badgeType": "EARN",
        "badgeStatus": "LIVE",
        "owner": [
            "Milestones",
            "Loyalty"
        ],
        "claimedBy": [],
        "images": [],
        "earnExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "WITH_BADGE_META",
            "expiresOn": null,
            "expireWithBadgeMeta": true
        },
        "badgeRank": 1,
        "activeEarnedCount": 0,
        "customFields": {}
    },
    "errors": [],
    "warnings": []
}

{
    "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"
        ],
        "claimedBy": [],
        "images": [
            {
                "name": "string",
                "fileSvcHandle": "string",
                "url": "string",
                "tag": "UN_EARNED"
            }
        ],
        "earnExpiry": {
            "expiryType": "RELATIVE",
            "relativeExpirytype": "DAYS",
            "value": 2
        },
        "issueExpiry": {
            "expiryType": "RELATIVE",
            "relativeExpirytype": "DAYS",
            "value": 2
        },
        "activeEarnedCount": 0,
        "customFields": {}
    },
    "errors": [],
    "warnings": []
}

{
    "data": {
        "id": "66cfffb195551c6e7d962a8a",
        "name": "Copy of Test 2",
        "description": "Test 2",
        "createdOn": 1724907441.472,
        "lastUpdatedOn": 1724907441.472,
        "startsOn": 1725129000,
        "expiresOn": 1727634600,
        "action": "ACTIVATED",
        "badgeType": "ISSUE_EARN",
        "badgeStatus": "UPCOMING",
        "owner": [
            "Loyalty_Promotion",
            "Milestones",
            "Rewards_Catalog",
            "Goodwill_Module",
            "Loyalty",
            "Audience_Campaigns",
            "Journeys",
            "Referral_Campaigns"
        ],
        "claimedBy": [],
        "images": [],
        "earnExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "FIXED_DATE",
            "expiresOn": 1727375400,
            "expireWithBadgeMeta": false
        },
        "issueExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "FIXED_DATE",
            "expiresOn": 1756319400,
            "expireWithBadgeMeta": false
        },
        "badgeGroupId": "6628a81728b59f41667acd23",
        "badgeGroupName": "group_1",
        "badgeRank": 2,
        "activeEarnedCount": 0,
        "customFields": {
            "tets-3": "2024-06-13 14:20:42",
            "test-19": "2024-06-11 14:24:43",
            "test-16": "2024-06-10 14:24:06",
            "msd-1": "true",
            "HiNikhil": "Helo",
            "test-23456": "2024-06-11 16:48:22",
            "AKV": "hi1",
            "test-21": "2024-06-06 14:25:14",
            "ka_test_1": "false",
            "test-789": "true"
        }
    },
    "errors": [],
    "warnings": []
}

{
    "data": {
        "id": "67037d51d33ceb2ad0a69b1b",
        "name": "Badge Issue earn283",
        "description": "Make 5 transactions",
        "createdOn": 1728281937.271000000,
        "lastUpdatedOn": 1728281937.271000000,
        "startsOn": 1721520000.000000000,
        "expiresOn": 1730957428.000000000,
        "action": "ACTIVATED",
        "badgeType": "ISSUE_EARN",
        "badgeStatus": "LIVE",
        "owner": [
            "Referral_Campaigns",
            "Rewards_Catalog",
            "Goodwill_Module",
            "Historical_Import",
            "Loyalty_Promotion",
            "Milestones",
            "Journeys",
            "Loyalty",
            "Audience_Campaigns"
        ],
        "claimedBy": [],
        "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"
            }
        ],
        "earnExpiry": {
            "expiryType": "RELATIVE",
            "relativeExpirytype": "WEEKS",
            "value": 2
        },
        "issueExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "FIXED_DATE",
            "expiresOn": 1926235957.000000000,
            "expireWithBadgeMeta": false
        },
        "badgeRank": 3,
        "customerConstraints": [
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "FIXED_WINDOW",
                "rollType": null,
                "refreshRate": 3,
                "durationType": "DAYS",
                "cycleStatus": "ACTIVE",
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 2,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": {
                    "startDate": 1728282321.257903000,
                    "endDate": 1728455121.257903000
                },
                "fixedWindowReferenceId": "e6791ec9-e92f-34af-bdc3-be2607fdf82c",
                "rollingWindowLimits": null
            }
        ],
        "badgeConstraints": [
            {
                "constraintLevel": "BADGE",
                "constraintType": "OVERALL",
                "rollType": null,
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 10000,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            },
            {
                "constraintLevel": "BADGE",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "WEEKS",
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": 1,
                "maxEarnLimit": 3000,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            },
            {
                "constraintLevel": "BADGE",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "DAYS",
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": 1,
                "maxEarnLimit": 300,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            }
        ],
        "issualDetails": {
            "issuedCount": 1,
            "issuals": [
                {
                    "issuedOn": 1728281969.300000000,
                    "issuedStatus": "REVOKED",
                    "issueExpiresOn": 1926235957.000000000,
                    "issueId": "67037d71d33ceb2ad0a69b1c",
                    "ownerType": "Loyalty",
                    "ownerReferenceId": "123456789",
                    "revokedOn": 1728282201.451000000,
                    "issueEventDate": 1728279028.000000000
                }
            ]
        },
        "issuedStatus": "REVOKED",
        "earnDetails": {
            "earnCount": 0,
            "earns": []
        },
        "activeEarnedCount": 0,
        "customFields": {
            "Terms and Condition": "<Enter your terms and condition here>"
        }
    },
    "errors": [],
    "warnings": []
}

Response parameters

Parameter	Data Type	Description
id	String	Unique identifier for the badge issue.
name	String	Name of the badge issue.
description	String	Description of the badge issue.
createdOn	Float	Timestamp when the badge issue was created, in epoch milliseconds timestamp format.
createdOnISO	String	Timestamp when the badge issue was created in ISO 8601 format, returned in the server time zone. EU server example 2025-09-10T15:00:00Z → 10 September 2025, 15:00:00 (UTC) India server example 2025-09-10T15:00:00+05:30 → 10 September 2025, 15:00:00 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
lastUpdatedOn	Float	Timestamp when the badge issue was last updated, in epoch timestamp format.
lastUpdatedOnISO	String	Timestamp when the badge issue was last updated in ISO 8601 format, returned in the server time zone. EU server example 2026-02-04T06:45:10.000Z → 04 February 2026, 06:45:10 (UTC) India server example 2026-02-04T12:15:10.000+05:30 → 04 February 2026, 12:15:10 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
startsOn	Float	Timestamp indicating when the badge issue starts, in epoch timestamp format.
startsOnISO	String	Timestamp indicating when the badge issue starts in ISO 8601 format, returned in the server time zone. EU server example 2026-02-04T06:46:02.000Z → 04 February 2026, 06:46:02 (UTC) India server example 2026-02-04T12:16:02.000+05:30 → 04 February 2026, 12:16:02 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
expiresOn	Float	Timestamp indicating when the badge issue expires, in epoch timestamp format.
expiresOnISO	String	Timestamp indicating when the badge issue expires in ISO 8601 format, returned in the server time zone. EU server example 2026-02-04T06:47:15.000Z → 04 February 2026, 06:47:15 (UTC) India server example 2026-02-04T12:17:15.000+05:30 → 04 February 2026, 12:17:15 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
action	String	The status of the badge issued
badgeType	Enum	Type of the badge. Supported values: Earn, Issue_Earn
badgeStatus	String	Current status of the badge
owner	Object	List of owners for the badge issue
claimedBy	Object	List of modules that have claimed the badge
ownerType	Enum	Type of the owner claiming the badge. Supported values: LOYALTY/REFERRAL_CAMPAIGNS/JOURNEYS/AUDIENCE_CAMPAIGNS/REWARDS_CATALOG/ GOODWILL_MODULE/ MILESTONES.
isActive	Boolean	Indicates whether the badge is currently active.
images	Object	List of images associated with the badge
name	String	Name of the image
filehandle	String	Service handle for the image file
url	String	URL of the image.
earnExpiry	Object	Details about the expiry of earning the badge
expiryType	Enum	Type 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.
relativeExpirytype	Enum	Type of relative expiry. Supported values: DAYS,WEEKS, MONTHS
value	Integer	Value indicating the duration of expiry
issueExpiry	Object	Details about the expiry of the badge issue
expiryType	Enum	Type 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.
customerConstraints	Object	List of constraints for customers
badgeConstraints	Object	List of badge constraints associated with the badge.
constraintType	Enum	Type of customer constraint. Supported values: "CUSTOMER_BADGE_FIXED_VALUE" and "CUSTOMER_BADGE_ROLLING_WINDOW". CUSTOMER_BADGE_FIXED_VALUE refers to the fixed earn limit for the customer. CUSTOMER_BADGE_ROLLING_WINDOW refers to the customer's earn limit calculated over a certain period in the past day/week/month.
maxEarnLimit	Integer	Maximum limit a customer can earn
issualDetails	Object	Details about the badge issuance, including count and individual issuance records.
issuedStatus	String	Status of the badge issuance
issueId	String	The unique ID of the issued badge that was intended for revocation.
earnDetails	Object	Details about earning the badge
activeEarnedCount	Integer	Count of currently active earned badges
lastEarnedOn	Float	Timestamp (in seconds) when the badge was last earned.
lastEarnedOnISO	String	Timestamp when the badge was last earned, in Unix epoch time (seconds). EU server example 1738651682 → 04 February 2026, 06:48:02 (UTC) India server example 1738671482 → 04 February 2026, 12:18:02 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.

Fixed window with includeStatistics=false
{
    "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"
        ],
        "claimedBy": [],
        "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",
                "rollType": null,
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 100,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null
            }
        ],
        "badgeConstraints": [
            {
                "constraintLevel": "BADGE",
                "constraintType": "OVERALL",
                "rollType": null,
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 1000,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null
            }
        ],
        "issualDetails": {
            "issuedCount": 0,
            "issuals": []
        },
        "earnDetails": {
            "earnCount": 0,
            "earns": []
        },
        "activeEarnedCount": 0,
        "customFields": {}
    },
    "errors": [],
    "warnings": []
}

{
    "data": {
        "id": "662749408fe258516a88fe89",
        "name": "BADGE123",
        "description": "Purchase 5 pet products in 3 months and get a pet grooming voucher",
        "createdOn": 1713850688.811,
        "lastUpdatedOn": 1713850688.811,
        "startsOn": 1716803487,
        "expiresOn": 1726804000,
        "action": "DE_ACTIVATED",
        "badgeType": "EARN",
        "badgeStatus": "LIVE",
        "owner": [
            "Milestones",
            "Loyalty"
        ],
        "claimedBy": [],
        "images": [],
        "earnExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "WITH_BADGE_META",
            "expiresOn": null,
            "expireWithBadgeMeta": true
        },
        "badgeRank": 1,
        "customerConstraints": [
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "FIXED_WINDOW",
                "rollType": null,
                "refreshRate": 3,
                "durationType": "DAYS",
                "cycleStatus": "ACTIVE",
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 1,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": {
                    "startDate": 1719900534.389096,
                    "endDate": 1720073334.389096
                },
                "fixedWindowReferenceId": "e6791ec9-e92f-34af-bdc3-be2607fdf82c"
            }
        ],
        "badgeConstraints": [
            {
                "constraintLevel": "BADGE",
                "constraintType": "FIXED_WINDOW",
                "rollType": null,
                "refreshRate": 3,
                "durationType": "DAYS",
                "cycleStatus": "ACTIVE",
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 2,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": {
                    "startDate": 1719900534.389096,
                    "endDate": 1720073334.389096
                },
                "fixedWindowReferenceId": "a1350b49-eb8e-3500-9e43-01f5493c91c1"
            }
        ],
        "issualDetails": {
            "issuedCount": 0,
            "issuals": []
        },
        "earnDetails": {
            "earnCount": 0,
            "earns": []
        },
        "activeEarnedCount": 0,
        "customFields": {}
    },
    "errors": [],
    "warnings": []
}

{
    "data": {
        "id": "662749408fe258516a88fe89",
        "name": "BADGE123",
        "description": "Purchase 5 pet products in 3 months and get a pet grooming voucher",
        "createdOn": 1713850688.811,
        "lastUpdatedOn": 1713850688.811,
        "startsOn": 1716803487,
        "expiresOn": 1726804000,
        "action": "DE_ACTIVATED",
        "badgeType": "EARN",
        "badgeStatus": "LIVE",
        "owner": [
            "Milestones",
            "Loyalty"
        ],
        "claimedBy": [],
        "images": [],
        "earnExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "WITH_BADGE_META",
            "expiresOn": null,
            "expireWithBadgeMeta": true
        },
        "badgeRank": 1,
        "activeEarnedCount": 0,
        "customFields": {}
    },
    "errors": [],
    "warnings": []
}

{
    "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"
        ],
        "claimedBy": [],
        "images": [
            {
                "name": "string",
                "fileSvcHandle": "string",
                "url": "string",
                "tag": "UN_EARNED"
            }
        ],
        "earnExpiry": {
            "expiryType": "RELATIVE",
            "relativeExpirytype": "DAYS",
            "value": 2
        },
        "issueExpiry": {
            "expiryType": "RELATIVE",
            "relativeExpirytype": "DAYS",
            "value": 2
        },
        "activeEarnedCount": 0,
        "customFields": {}
    },
    "errors": [],
    "warnings": []
}

{
    "data": {
        "id": "66cfffb195551c6e7d962a8a",
        "name": "Copy of Test 2",
        "description": "Test 2",
        "createdOn": 1724907441.472,
        "lastUpdatedOn": 1724907441.472,
        "startsOn": 1725129000,
        "expiresOn": 1727634600,
        "action": "ACTIVATED",
        "badgeType": "ISSUE_EARN",
        "badgeStatus": "UPCOMING",
        "owner": [
            "Loyalty_Promotion",
            "Milestones",
            "Rewards_Catalog",
            "Goodwill_Module",
            "Loyalty",
            "Audience_Campaigns",
            "Journeys",
            "Referral_Campaigns"
        ],
        "claimedBy": [],
        "images": [],
        "earnExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "FIXED_DATE",
            "expiresOn": 1727375400,
            "expireWithBadgeMeta": false
        },
        "issueExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "FIXED_DATE",
            "expiresOn": 1756319400,
            "expireWithBadgeMeta": false
        },
        "badgeGroupId": "6628a81728b59f41667acd23",
        "badgeGroupName": "group_1",
        "badgeRank": 2,
        "activeEarnedCount": 0,
        "customFields": {
            "tets-3": "2024-06-13 14:20:42",
            "test-19": "2024-06-11 14:24:43",
            "test-16": "2024-06-10 14:24:06",
            "msd-1": "true",
            "HiNikhil": "Helo",
            "test-23456": "2024-06-11 16:48:22",
            "AKV": "hi1",
            "test-21": "2024-06-06 14:25:14",
            "ka_test_1": "false",
            "test-789": "true"
        }
    },
    "errors": [],
    "warnings": []
}

{
    "data": {
        "id": "67037d51d33ceb2ad0a69b1b",
        "name": "Badge Issue earn283",
        "description": "Make 5 transactions",
        "createdOn": 1728281937.271000000,
        "lastUpdatedOn": 1728281937.271000000,
        "startsOn": 1721520000.000000000,
        "expiresOn": 1730957428.000000000,
        "action": "ACTIVATED",
        "badgeType": "ISSUE_EARN",
        "badgeStatus": "LIVE",
        "owner": [
            "Referral_Campaigns",
            "Rewards_Catalog",
            "Goodwill_Module",
            "Historical_Import",
            "Loyalty_Promotion",
            "Milestones",
            "Journeys",
            "Loyalty",
            "Audience_Campaigns"
        ],
        "claimedBy": [],
        "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"
            }
        ],
        "earnExpiry": {
            "expiryType": "RELATIVE",
            "relativeExpirytype": "WEEKS",
            "value": 2
        },
        "issueExpiry": {
            "expiryType": "ABSOLUTE",
            "type": "FIXED_DATE",
            "expiresOn": 1926235957.000000000,
            "expireWithBadgeMeta": false
        },
        "badgeRank": 3,
        "customerConstraints": [
            {
                "constraintLevel": "CUSTOMER",
                "constraintType": "FIXED_WINDOW",
                "rollType": null,
                "refreshRate": 3,
                "durationType": "DAYS",
                "cycleStatus": "ACTIVE",
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 2,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": {
                    "startDate": 1728282321.257903000,
                    "endDate": 1728455121.257903000
                },
                "fixedWindowReferenceId": "e6791ec9-e92f-34af-bdc3-be2607fdf82c",
                "rollingWindowLimits": null
            }
        ],
        "badgeConstraints": [
            {
                "constraintLevel": "BADGE",
                "constraintType": "OVERALL",
                "rollType": null,
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": null,
                "maxEarnLimit": 10000,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            },
            {
                "constraintLevel": "BADGE",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "WEEKS",
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": 1,
                "maxEarnLimit": 3000,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            },
            {
                "constraintLevel": "BADGE",
                "constraintType": "ROLLING_WINDOW",
                "rollType": "DAYS",
                "refreshRate": null,
                "durationType": null,
                "cycleStatus": null,
                "startDayOfTheWeek": null,
                "rollValue": 1,
                "maxEarnLimit": 300,
                "earnConstraintBlockStatistics": {
                    "currentEarnCount": 0,
                    "currentEarnCountDays": null,
                    "currentEarnCountWeeks": null,
                    "currentEarnCountMonths": null
                },
                "fixedWindowCycle": null,
                "fixedWindowReferenceId": null,
                "rollingWindowLimits": null
            }
        ],
        "issualDetails": {
            "issuedCount": 1,
            "issuals": [
                {
                    "issuedOn": 1728281969.300000000,
                    "issuedStatus": "REVOKED",
                    "issueExpiresOn": 1926235957.000000000,
                    "issueId": "67037d71d33ceb2ad0a69b1c",
                    "ownerType": "Loyalty",
                    "ownerReferenceId": "123456789",
                    "revokedOn": 1728282201.451000000,
                    "issueEventDate": 1728279028.000000000
                }
            ]
        },
        "issuedStatus": "REVOKED",
        "earnDetails": {
            "earnCount": 0,
            "earns": []
        },
        "activeEarnedCount": 0,
        "customFields": {
            "Terms and Condition": "<Enter your terms and condition here>"
        }
    },
    "errors": [],
    "warnings": []
}

Note

Example request

Prerequisites

Resource information

Headers

API endpoint example

Request path parameters

Request query parameter

Example response

Response parameters

200200

400400