Leveling

GET /api/guilds/{guild_id}/leaderboard

GetLeaderboard

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
limit	query	integer	no
offset	query	integer	no

Response 200 — Request fulfilled, document follows

Model: LeaderboardPage

Field	Type	Required	Description
entries	array of LeaderboardEntry	yes
total	integer	yes
limit	integer	yes
offset	integer	yes

GET /api/guilds/{guild_id}/level-roles

ListLevelRoles

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes

Response 200 — Request fulfilled, document follows

Model: array of LevelRoleSchema

Type: array of LevelRoleSchema

DELETE /api/guilds/{guild_id}/level-roles/{level}

DeleteLevelRole

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
level	path	integer	yes

Response 204 — Request fulfilled, nothing follows

PUT /api/guilds/{guild_id}/level-roles/{level}

SetLevelRole

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
level	path	integer	yes

Request body

Model: LevelRoleUpsert

Field	Type	Required	Description
role_id	integer	yes

Response 200 — Request fulfilled, document follows

Model: LevelRoleSchema

Field	Type	Required	Description
level	integer	yes
role_id	integer	yes

GET /api/guilds/{guild_id}/members/{user_id}/rank

GetRank

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
user_id	path	integer	yes

Response 200 — Request fulfilled, document follows

Model: RankSchema

Field	Type	Required	Description
user_id	integer	yes
rank	integer | null	yes
xp	integer	yes
level	integer	yes
message_count	integer	yes
xp_into_level	integer	yes
xp_for_next_level	integer	yes

POST /api/guilds/{guild_id}/members/{user_id}/xp

AwardXp

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
user_id	path	integer	yes

Response 200 — Request fulfilled, document follows

Model: XPAwardResult

Field	Type	Required	Description
awarded	boolean	yes
amount	integer	yes
xp	integer	yes
level	integer	yes
previous_level	integer	yes
leveled_up	boolean	yes
earned_role_ids	array of integer	no
remove_role_ids	array of integer	no

PUT /api/guilds/{guild_id}/members/{user_id}/xp

SetXp

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
user_id	path	integer	yes

Request body

Model: SetXPRequest

Field	Type	Required	Description
xp	integer	yes

Response 200 — Request fulfilled, document follows

Model: MemberLevelSchema

Field	Type	Required	Description
guild_id	integer	yes
user_id	integer	yes
xp	integer	yes
level	integer	yes
message_count	integer	yes