GET
/
ranking
Get information about the ranking key
curl --request GET \
  --url https://api.readmin.app/ranking \
  --header 'api-key: <api-key>'
{
  "success": true,
  "keyInfo": {
    "_id": "<string>",
    "groupId": "<string>",
    "id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "rankingEnabled": true,
    "enableShouting": {
      "allowedRanks": [
        "<string>"
      ]
    },
    "enableJoinRequestManagement": true,
    "enableExile": true,
    "created": "<string>"
  }
}

Authorizations

​
api-key
string
header
required

Response

200
application/json

Returns information about the bot

The response is of type object.