Skip to main content

Get Badges

Provides a list of all active badges in your gamification system. Badges are visual achievements that players earn through completing conditions.

Endpoint

GET /v1/admin/badges

Response

{
"code": 200,
"data": [
{
"uid": "10e9ca36299147f5b852ac03f7b18c63",
"label": "Weekend Warrior",
"points": 0,
"description": "Place 2 bets in a weekend. 1 in Saturday, 1 in Sunday",
"startDate": "2010-01-10T00:00:00",
"endDate": "2040-12-31T00:00:00",
"requiredBadgeUId": null,
"imageName": "https://rapidmulestorage.blob.core.windows.net/images/7709bec5-e2ad-490f-b25f-ade35975f7a5_helmet.png",
"isActive": true,
"type": "OneTimeOnly"
},

Request Example

curl -X GET https://api.rapidmule.com/v1/admin/badges \
-H "Authorization: Bearer YOUR_API_KEY"

Error Codes

CodeDescriptionResolution
1001Payload is nullCheck request body
4001Invalid AuthKeyVerify API key
9004Badge does not existUse valid badgeId
Learn More

For a deeper understanding of Badges, see Core Concepts - Badges & Triggers.