Badge Detail

Provides detailed information for a specific badge by its unique identifier, including all associated deliverables.

Endpoint

GET /v1/admin/badges/{badgeID}

Path Parameters

Parameter	Type	Required	Description
badgeID	string	Yes	Unique identifier for the badge

Response

{
"code": 200,
"data": [
  {
    "uid": "e172ed2a007141868971a42e824fe124",
    "label": "100th Bet",
    "points": 100,
    "description": null,
    "startDate": "2010-01-10T00:00:00",
    "endDate": "2040-12-31T00:00:00",
    "requiredBadgeUId": null,
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/85ee95de-33a5-42dc-b858-b7fa27003fd8_anniversary.png",
    "isActive": true,
    "type": "OneTimeOnly",
    "deliverables": [

Response Fields

Field	Type	Description
uid	string	Unique identifier for the badge
label	string	Display name of the badge
points	number	Points awarded when badge is earned
description	string	Description of the badge
startDate	string	ISO 8601 timestamp of when the badge becomes active
endDate	string	ISO 8601 timestamp of when the badge expires
requiredBadgeUId	string	UID of badge required before this can be earned
imageName	string	URL to the badge's icon/image
isActive	boolean	Whether this badge is currently active
type	string	Badge type: OneTimeOnly, Repeatable, or Ranked
deliverables	array	List of deliverables issued when badge is earned

Request Example

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

Use Cases

• Badge Rewards Display: Show players what rewards they'll earn
• Badge Prerequisites: Check if badge requires other badges to unlock
• Badge Type Analysis: Categorize badges by type (OneTimeOnly, Repeatable, Ranked)

Badge Types

Type	Description
OneTimeOnly	Can be earned only once per player
Repeatable	Can be earned multiple times
Ranked	Has multiple levels/ranks

Error Codes

Code	Description	Resolution
1001	Payload is null	Check path parameters
4001	Invalid AuthKey	Verify API key
9004	Badge does not exist	Use valid badgeId

Learn More

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