Loyi API Reference
  1. Leveling
Loyi API Reference
  • Getting Started
  • Architecture
  • User
    • Users Overview
    • Create user
      POST
    • Get users
      GET
    • Get user
      GET
    • Update user
      PUT
    • Delete user
      DELETE
  • Reward
    • Rewards Overview
    • Create reward
      POST
    • Get rewards
      GET
    • Delete reward
      DELETE
    • Create entry pass code
      POST
    • Get entry pass code
      GET
    • Airdrop reward
      PUT
    • Award reward
      POST
    • Redeem rewards
      GET
  • Collection
    • Collection Overview
    • Create collection
      POST
    • Get collections
      GET
    • Get collection
      GET
    • Update collection
      PUT
    • Delete collection
      DELETE
    • Get rewards
      GET
  • Collectible
    • Claim collectible
    • Get collectibles
  • Quest
    • Quest Overview
    • Create quest
    • Get quests
    • Get quest
    • Update quest
    • Delete quest
    • Get participants
    • Accept quest
    • Submit answers
    • Get answers
  • Leaderboard
    • Leaderboard Overview
    • Get leaderboard
  • Leveling
    • Get leveling configuration
      GET
    • Configure leveling
      PUT
    • Get milestone levels
      GET
    • Create milestone level
      POST
    • Get milestone level
      GET
    • Update milestone level
      PUT
    • Delete milestone level
      DELETE
  1. Leveling

Get leveling configuration

Staging
https://testserver.loyi.io/public/api
Staging
https://testserver.loyi.io/public/api
GET
/leveling
Leveling
Returns the leveling configuration.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Header Params
Origin
string 
required
The value must be one of the whitelisted domains. You can whitelist domain URLs on your Loyi dashboard.
Default:
<WHITELISTED_URL>
Example:
https://example.com

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://testserver.loyi.io/public/api/leveling' \
--header 'Origin;' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
Ok
Body
isActive
boolean 
required
Whether the leveling is active.
unitName
string 
required
Name of the leveling unit.
type
enum<string> 
required
Type of the leveling.
Allowed values:
linearexp
incrementBy
number 
required
Increment value.
multiplyBy
number 
required
Multiplier value used when type is exp.
Example
{
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "isActive": true,
    "unitName": "Miles",
    "type": "linear",
    "incrementBy": 50,
    "multiplyBy": 1
}
🟠401Unauthorized
Modified at 2025-06-19 21:23:41
Previous
Get leaderboard
Next
Configure leveling
Built with