1. Gamification
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Rewards & Redemptions
    • Store catalog to redemptions
    • Update redemption order status or refund
      PUT
    • List redemption orders by user email
      POST
    • List redemption statuses
      POST
    • Get redemption status by ID
      POST
    • List redemption orders by community
      POST
    • Create redemption order status
      POST
    • Get redemption order status history
      POST
  • Chart Analysis
    • Create Analysis
    • Get Analysis
    • Update Analysis
    • Delete Analysis
    • List Analyses
    • Append Drawings
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
    • Get bulk update job status
    • Get bulk update job details
    • Bulk update users from CSV
    • Bulk update premium currency from CSV
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • User Fields
    • User field definitions and history
    • User Field History
      • Get all user field histories in a community
      • Get user field histories for a specific field
      • Get user field histories for a specific user
      • Get user field histories of specific user field and user
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Get A User Field Definition
    • Update A User Field Definition
    • Create A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  1. Gamification

Get tier configuration

GET
/v1/xp-settings/tiers-info

What this endpoint does#

Returns XP tier configuration for one community.
It does not change XP. An empty data object means this community has no tiers configured, not that the route failed.
INFO
Workflow
GET /v1/xp-settings/tiers-info?communityId=<communityId> → if data is {}, there are no tiers to compare against member XP.

Quick start#

communityId is required. Omitting it returns 400.

Authentication and permission#

Bearer community API key. Required permission: getTiersInfo. The communityId query must match the key's community. Keep the key server-side.

Complete examples#

Configured or empty (200). message is Tiers info fetched successfully. data may be {} when no tiers exist.
Missing query (400). { "status": "error", "message": "Community ID is required" }.

Success and readback#

HTTP 200. Repeat after admin changes tiers. This GET is the readback for tier configuration.

Errors and recovery#

StatusWhenRecovery
400 Community ID is requiredNo communityIdAdd the 24-character community ObjectId.
401Missing or invalid tokenAdd a valid community key with getTiersInfo.

Retry safety#

TIP
Exact retry
This GET does not write tiers. Retry timeouts with bounded backoff.

Gotchas#

Do not omit communityId and expect the key to fill it in.
Empty data is success.

Next steps#

Get User Data
Compare member XP against these tiers after you have a non-empty configuration.

Request

Query Params

Header Params

Responses

🟢200Success
application/json
Returns a populated or empty tier configuration.
Bodyapplication/json

🟠400Invalid Community
🟠401Authentication or Permission Error
🔴500Invalid ObjectId or Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-integration.returning.ai/apis/v1/xp-settings/tiers-info?communityId=64b7f3a2c8d4e6f102938475' \
--header 'Authorization: Bearer <COMMUNITY_API_KEY>'
Response Response Example
200 - Configured tiers
Fully synthetic example; names and thresholds vary by community.
{
  "status": "success",
  "message": "Tiers info fetched successfully",
  "data": {
    "Explorer": {
      "Bronze": "0 XP",
      "Silver": "500 XP",
      "Gold": "1500 XP"
    },
    "Challenger": {
      "Bronze": "3000 XP",
      "Silver": "6000 XP",
      "Gold": "10000 XP"
    },
    "Champion": {
      "Bronze": "15000 XP",
      "Silver": "22000 XP",
      "Gold": "30000 XP"
    }
  }
}
Modified at 2026-08-19 13:44:36
Previous
Get Rolling Calculation Data
Next
Get daily user XP and coin changes
Built with