Get Levels

Provides a list of all player levels configured in your gamification system, including point thresholds and level metadata.

Endpoint

GET /v1/admin/levels

Response

{
"code": 200,
"data": [
  {
    "uid": "4406086043524e158b616638100f1a01",
    "label": "Level 1",
    "level": 1,
    "description": "Welcome to the RapidMule! Your journey has just started!",
    "target": 0,
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/21188a25-9656-40ad-95a3-e3dfabbe641c_number-one.png",
    "isActive": true
  },
  {
    "uid": "91d9b2970ee141adac1b2c4286f49ac3",
    "label": "Level 2",
    "level": 2,
    "description": "Now you're talking!",
    "target": 1000,
    "imageName": "https://rapidmulestorage.blob.core.windows.net/images/ac1d7abf-4d6d-4caf-a4ad-35804fc1701e_two.png",
    "isActive": true

Response Fields

Field	Type	Description
uid	string	Unique identifier for the level
label	string	Display name of the level
level	number	Level number/rank
description	string	Description shown to players at this level
target	number	Total points required to reach this level
imageName	string	URL to the level's icon/image
isActive	boolean	Whether this level is currently active

Request Example

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

Use Cases

• Level Progression UI: Display current level and progress to next level
• Level Dropdown: Create level selection dropdowns for admin interfaces
• Progress Bar: Calculate percentage progress toward next level
• Leaderboard Context: Show player levels on leaderboards

Level Configuration Patterns

Linear Progression

// Points double at each level
Level 1: 0 points
Level 2: 1000 points
Level 3: 2000 points
Level 4: 4000 points
Level 5: 8000 points

Milestone Levels

// Special themed levels at milestones
Level 10: "Champion" - 256,000 points
Level 11: "Spartan Level 1" - 512,000 points
Level 12: "Spartan Level 2" - 700,000 points

Error Codes

Code	Description	Resolution
1001	Payload is null	Check request parameters
4001	Invalid AuthKey	Verify API key

Note

Levels are ordered sequentially by their level number. The target field represents cumulative points, not points per level.

Integration Tip

Cache level data in your frontend to reduce API calls, as level configurations typically don't change frequently.