get https://{host}/api_gateway/v1/badges/management//badge/
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 .
Prerequisites
- Authentication: Basic 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 |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/management/381921157/badge/65ae47103c2f9e39583095a4
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. |
https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/management/381921157/badge/65ae47103c2f9e39583095a4
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. |
| lastUpdatedOn | Float | Timestamp when the badge issue was last updated. |
| startsOn | Float | Timestamp indicating when the badge issue starts. |
| expiresOn | Float | Timestamp indicating when the badge issue expires. |
| 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. |
| expiresOn | String | Expiration time of the badge. |
| tags | Objects | List of tags associated with the badge |
| name | String | Name of the tag. |
| value | String | Value of the tag. |
| 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 |
| 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. |
{
"data": {
"id": "660bf3b58bdfa71c4496a98a",
"name": "Super star badge",
"description": null,
"createdOn": 1712059317.866000000,
"lastUpdatedOn": 1713940126.143000000,
"startsOn": 1712059761.000000000,
"expiresOn": 1740681000.000000000,
"action": "ACTIVATED",
"badgeType": "ISSUE_EARN",
"badgeStatus": "LIVE",
"owner": [
"Journeys",
"Audience_Campaigns",
"Loyalty"
],
"claimedBy": [
{
"ownerType": "Loyalty",
"referenceId": "626_TargetCompleted",
"isActive": true
},
{
"ownerType": "Audience_Campaigns",
"referenceId": "227191",
"isActive": true
},
{
"ownerType": "Loyalty",
"referenceId": "123",
"isActive": true
},
{
"ownerType": "Loyalty",
"referenceId": "1231",
"isActive": true
},
{
"ownerType": "Loyalty",
"referenceId": "12311",
"isActive": true
}
],
"images": [],
"earnExpiry": {
"expiryType": "NEVER"
},
"issueExpiry": {
"expiryType": "NEVER"
},
"tags": [],
"customerConstraints": [
{
"constraintLevel": "CUSTOMER",
"constraintType": "ROLLING_WINDOW",
"rollType": null,
"refreshRate": null,
"durationType": null,
"cycleStatus": null,
"startDayOfTheWeek": null,
"rollValue": null,
"maxEarnLimit": null,
"earnConstraintBlockStatistics": {
"currentEarnCount": null,
"currentEarnCountDays": 0,
"currentEarnCountWeeks": 0,
"currentEarnCountMonths": 0
},
"fixedWindowCycle": null,
"fixedWindowReferenceId": null
}
],
"badgeConstraints": [],
"issualDetails": {
"issuedCount": 1,
"issuals": [
{
"issuedOn": 1713937722.591000000,
"issuedStatus": "ACTIVE",
"issueExpiresOn": null,
"issueId": "66289d3a0b50ae4de0cd13d4",
"ownerType": "Loyalty",
"ownerReferenceId": "123",
"revokedOn": null
}
]
},
"issuedStatus": "ACTIVE",
"earnDetails": {
"earnCount": 0,
"earns": []
},
"activeEarnedCount": 0,
"lastEarnedOn": null,
"customFields": {
"2024": "false",
"Date": "2025-01-18 14:39:09"
}
},
"errors": [],
"warnings": []
}
{
"data": {
"id": "6628c3240b50ae4de0cd14c9",
"name": "ASDFBADGE1",
"description": "Make 5 transactions in a month, get a badge and 10% off coupon",
"createdOn": 1713947428.347000000,
"lastUpdatedOn": 1713947442.635000000,
"startsOn": 1806803487.000000000,
"expiresOn": 1806804000.000000000,
"action": "ACTIVATED",
"badgeType": "ISSUE_EARN",
"badgeStatus": "UPCOMING",
"owner": [
"Loyalty",
"Audience_Campaigns"
],
"claimedBy": [
{
"ownerType": "Loyalty",
"referenceId": "12311",
"isActive": true
}
],
"images": [],
"earnExpiry": {
"expiryType": "RELATIVE",
"relativeExpirytype": "WEEKS",
"value": 2
},
"issueExpiry": {
"expiryType": "ABSOLUTE",
"type": "FIXED_DATE",
"expiresOn": 1806804000.000000000,
"expireWithBadgeMeta": false
},
"tags": [],
"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"
}
],
"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
},
{
"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
},
{
"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
}
],
"issualDetails": {
"issuedCount": 1,
"issuals": [
{
"issuedOn": 1713947480.066000000,
"issuedStatus": "ACTIVE",
"issueExpiresOn": 1806804000.000000000,
"issueId": "6628c3580b50ae4de0cd14ca",
"ownerType": "Loyalty",
"ownerReferenceId": "12311",
"revokedOn": null
}
]
},
"issuedStatus": "ACTIVE",
"earnDetails": {
"earnCount": 0,
"earns": []
},
"activeEarnedCount": 0,
"lastEarnedOn": null,
"customFields": {
"2024": "true",
"Date": "2025-01-18T09:09:09Z"
}
},
"errors": [],
"warnings": []
}
{
"data": {
"id": "6628c3240b50ae4de0cd14c9",
"name": "ASDFBADGE1",
"description": "Make 5 transactions in a month, get a badge and 10% off coupon",
"createdOn": 1713947428.347000000,
"lastUpdatedOn": 1713947442.635000000,
"startsOn": 1806803487.000000000,
"expiresOn": 1806804000.000000000,
"action": "ACTIVATED",
"badgeType": "ISSUE_EARN",
"badgeStatus": "UPCOMING",
"owner": [
"Loyalty",
"Audience_Campaigns"
],
"claimedBy": [
{
"ownerType": "Loyalty",
"referenceId": "12311",
"isActive": true
}
],
"images": [],
"earnExpiry": {
"expiryType": "RELATIVE",
"relativeExpirytype": "WEEKS",
"value": 2
},
"issueExpiry": {
"expiryType": "ABSOLUTE",
"type": "FIXED_DATE",
"expiresOn": 1806804000.000000000,
"expireWithBadgeMeta": false
},
"tags": [],
"customerConstraints": null,
"badgeConstraints": null,
"issualDetails": null,
"issuedStatus": null,
"earnDetails": null,
"activeEarnedCount": 0,
"lastEarnedOn": null,
"customFields": {
"2024": "true",
"Date": "2025-01-18T09:09:09Z"
}
},
"errors": [],
"warnings": []
}
{
"data": {
"id": "660bf3b58bdfa71c4496a98a",
"name": "Super star badge",
"description": null,
"createdOn": 1712059317.866000000,
"lastUpdatedOn": 1713940126.143000000,
"startsOn": 1712059761.000000000,
"expiresOn": 1740681000.000000000,
"action": "ACTIVATED",
"badgeType": "ISSUE_EARN",
"badgeStatus": "LIVE",
"owner": [
"Journeys",
"Audience_Campaigns",
"Loyalty"
],
"claimedBy": [
{
"ownerType": "Loyalty",
"referenceId": "626_TargetCompleted",
"isActive": true
},
{
"ownerType": "Audience_Campaigns",
"referenceId": "227191",
"isActive": true
},
{
"ownerType": "Loyalty",
"referenceId": "123",
"isActive": true
},
{
"ownerType": "Loyalty",
"referenceId": "1231",
"isActive": true
},
{
"ownerType": "Loyalty",
"referenceId": "12311",
"isActive": true
}
],
"images": [],
"earnExpiry": {
"expiryType": "NEVER"
},
"issueExpiry": {
"expiryType": "NEVER"
},
"tags": [],
"customerConstraints": null,
"badgeConstraints": null,
"issualDetails": null,
"issuedStatus": null,
"earnDetails": null,
"activeEarnedCount": 0,
"lastEarnedOn": null,
"customFields": {
"2024": "false",
"Date": "2025-01-18 14:39:09"
}
},
"errors": [],
"warnings": []
}