Skip to content

Returns the leaderboard level definitions with their point thresholds, plus the members excluded from ranking.

Endpoint

  • Method: GET

  • Path: /admin/leaderboards/levels

  • Edition: PRO

  • Controller: LeaderBoardController@getLevels

  • Route source: fluent-community-pro/app/Modules/LeaderBoard/Http/leaderboard_api.php:12

  • Requires the FluentCommunity community-admin permission (or a WordPress super admin).

  • Requires FluentCommunity Pro; the excluded-member list includes email addresses.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET Get Leaderboard Levels

GET
/admin/leaderboards/levels

Returns the leaderboard level definitions with their point thresholds, plus the members excluded from ranking.

Controller: LeaderBoardController@getLevels
Route source: fluent-community-pro/app/Modules/LeaderBoard/Http/leaderboard_api.php:12

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"excludedUserIds": [
  
  
{
  
  
  
"additionalProperties": "string"
  
  
}
  
],
  
"excludedUsers": [
  
  
{
  
  
  
"additionalProperties": "string"
  
  
}
  
],
  
"levels": {
  
  
"__truncated__": "string",
  
  
"level_1": {
  
  
  
"level": 0,
  
  
  
"max_points": 0,
  
  
  
"min_points": 0,
  
  
  
"slug": "string",
  
  
  
"tagline": "string",
  
  
  
"title": "string"
  
  
},
  
  
"level_2": {
  
  
  
"level": 0,
  
  
  
"max_points": 0,
  
  
  
"min_points": 0,
  
  
  
"slug": "string",
  
  
  
"tagline": "string",
  
  
  
"title": "string"
  
  
}
  
}
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation