Leeaderboard

Trusted Server API References for Leaderboard Service

Retrieves a list of leaderboards based on the provided parameters.

get

Query parameters

labelstringOptional

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Responses

200

OK

text/plainapplication/jsontext/json

get

/server/services/leaderboard

HTTPcURLJavaScriptPython

GET /server/services/leaderboard HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "desc": "text",
      "label": "text",
      "unique_by": "text",
      "order": 0,
      "actions": "text",
      "extend_table": "text",
      "participants": 0,
      "course": 1,
      "timeframe": 1,
      "ttl": 1,
      "round": 1,
      "winners_count": 1,
      "last_wipe": "2025-12-19T17:59:51.003Z"
    }
  ],
  "totalCount": 1
}

Retrieves the score of the current user based on the input parameters.

post

Path parameters

leaderboardIdinteger · int32Required

Query parameters

callerinteger · int32Optional

Body

application/jsontext/jsonapplication/*+json

return_mebooleanOptional

Responses

200

OK

text/plainapplication/jsontext/json

post

/server/services/leaderboard/{leaderboardId}/me

HTTPcURLJavaScriptPython

POST /server/services/leaderboard/{leaderboardId}/me HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "return_me": true
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "row": null
}

Obtains scores for individual users as specified by the input parameters.

post

Path parameters

leaderboardIdinteger · int32Required

Query parameters

callerinteger · int32Optional

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Body

application/jsontext/jsonapplication/*+json

return_mebooleanOptional

Responses

200

OK

text/plainapplication/jsontext/json

post

/server/services/leaderboard/user/{leaderboardId}

HTTPcURLJavaScriptPython

POST /server/services/leaderboard/user/{leaderboardId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "return_me": true
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "list": [],
  "totalCount": 1
}

Fetches scores for different parties according to the given parameters.

post

Path parameters

leaderboardIdinteger · int32Required

Query parameters

callerinteger · int32Optional

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Body

application/jsontext/jsonapplication/*+json

return_mebooleanOptional

Responses

200

OK

text/plainapplication/jsontext/json

post

/server/services/leaderboard/party/{leaderboardId}

HTTPcURLJavaScriptPython

POST /server/services/leaderboard/party/{leaderboardId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "conditions": {
    "op": "text",
    "field": "text",
    "value": null,
    "values": [],
    "list": [
      {
        "op": "text",
        "field": "text",
        "value": null,
        "values": [],
        "list": [
          {
            "op": "text",
            "field": "text",
            "value": null,
            "values": [],
            "list": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "return_me": true
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "list": [],
  "totalCount": 1
}

Gathers scores specifically for friends of the current user.

get

Path parameters

leaderboardIdinteger · int32Required

Query parameters

callerinteger · int32Optional

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 25

Body

application/jsontext/jsonapplication/*+json

opstring | nullableOptional

fieldstring | nullableOptional

valueany | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

get

/server/services/leaderboard/{leaderboardId}/friends

HTTPcURLJavaScriptPython

GET /server/services/leaderboard/{leaderboardId}/friends HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "op": "text",
  "field": "text",
  "value": null,
  "values": [],
  "list": [
    {
      "op": "text",
      "field": "text",
      "value": null,
      "values": [],
      "list": [
        {
          "op": "text",
          "field": "text",
          "value": null,
          "values": [],
          "list": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "row": null
}

Submits a user's score and returns the result.

post

Path parameters

leaderboardIdinteger · int32Required

Query parameters

callerinteger · int32Optional

Body

application/jsontext/jsonapplication/*+json

scoreinteger · int32Optional

party_Idinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

post

/server/services/leaderboard/{leaderboardId}

HTTPcURLJavaScriptPython

POST /server/services/leaderboard/{leaderboardId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "score": 1,
  "other_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "party_Id": 1
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "affected": 1
}