Get Ranks

Provides a list of all rank sets (also called badge levels) configured in your gamification system. Rank sets define the tiered progression a badge or trigger can climb — for example a Bronze → Silver → Gold chain.

Endpoint

GET /v1/admin/ranks

Query Parameters

Parameter	Type	Required	Description
isactive	boolean	No	Filter by active state. Omit to return all rank sets

Response

Success Response

{
"code": 200,
"data": [
  {
    "uid": "5494f305135d429ba4d257fec8e13c94",
    "label": "Oyuncu İlerleme Seviyeleri",
    "isActive": true
  },
  {
    "uid": "79f0cddf25f643f5a11ddeed7bf548a4",
    "label": "Rank_2",
    "isActive": true
  }
]
}

Response Fields

Field	Type	Description
uid	string	Unique identifier for the rank set
label	string	Display name of the rank set
isActive	boolean	Whether this rank set is currently active

Request Example

curl -X GET https://api.rapidmule.com/v1/admin/ranks \
  -H "AuthKey: YOUR_API_KEY"

Use Cases

• Admin Dashboard: Display all configured rank sets
• Badge Configuration: Reference rank sets when setting up ranked badges and triggers
• Progression Analysis: Review the tiered progressions available in your program

Error Codes

Code	Description	Resolution
4001	Invalid AuthKey	Verify API key

Note

Ranks (badge levels) power the tiered progression of badges and triggers. For player point levels, see Player Levels.