Documentation - KB RolePlay

Description: Fetch your punishments from a specific category

Ratelimit: 5 per 10s

Permissions: punishments-moderation.read-me or punishments-team.read-me

The owner of the token needs to be a moderator to fetch oral_warn punishments

The permission punishments-{{category}}.view-deleted is required to fetch deleted punishments

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category of the punishments you want to fetch (`moderation` \| `team`)

Query parameters

Name	Type	Description	Default
active	boolean	If you want to fetch only active punishments or not	❌
type	string	The type of the punishment you want to fetch (enum: `oral_warn \| warn \| kick \| mute \| ban`)	❌
deleted	boolean	If you want to fetch only deleted punishments or not	❌
teamNames	string	The team name of the punishment you want to fetch (comma separated)	❌
page	number	The page number (min: `1`)	1
perpage	number	The limit of elements per page (min: `1`, max: `100`)	10
search	string	The search query (only first 50 characters will be considered)	❌
sortby	string	The column to sort by	id
sortdir	string	The direction to sort by (enum: `asc \| desc`)	desc

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_ACTIVE`	The value doesn't follow the requirements
400	`INVALID_DELETED`	The value doesn't follow the requirements
400	`INVALID_PAGE`	The value doesn't follow the requirements
400	`INVALID_PERPAGE`	The value doesn't follow the requirements
400	`INVALID_PUNISHMENT_CATEGORY`	The value `category` doesn't follow the requirements
400	`INVALID_PUNISHMENT_TYPE`	The value `type` doesn't follow the requirements
400	`INVALID_SEARCH`	The value doesn't follow the requirements
400	`INVALID_SERVER_ID`	The server id is invalid
400	`INVALID_SORTBY`	The value doesn't follow the requirements
400	`INVALID_SORTDIR`	The value doesn't follow the requirements
400	`INVALID_TEAM_NAMES`	The value doesn't follow the requirements
400	`INVALID_TYPE`	The value doesn't follow the requirements
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"
data[]:
- id: number
- category: string
- authorId: number
- author:
  - id: number
  - name: string
  - uuid: string
  - firstConnection: date
  - lastConnection: date
  - lastDashboardConnection: date | null
  - accountName: string | null
  - accountType: string
  - accountId: number
  - avatarUrl: string
  - discordUsername: string | null
  - discordDiscriminator: string | null
  - serverId: number
  - roles[]:
    - serverId: number
    - id: number
    - name: string
    - color: string
    - position: number | null
    - categories:
      - id: number
      - name: string
    - deletedAt: date | null
  - language:
    - alpha2: string
    - name: string
- targetId: number
- target:
  - id: number
  - name: string
  - uuid: string
  - firstConnection: date
  - lastConnection: date
  - lastDashboardConnection: date | null
  - accountName: string | null
  - accountType: string
  - accountId: number
  - avatarUrl: string
  - discordUsername: string | null
  - discordDiscriminator: string | null
  - serverId: number
  - roles[]:
    - serverId: number
    - id: number
    - name: string
    - color: string
    - position: number | null
    - categories:
      - id: number
      - name: string
    - deletedAt: date | null
  - language:
    - alpha2: string
    - name: string
- reason: string
- description: string | null
- gravity:
- date: string
- type:
- active: boolean | null
- duration: number | null
- teamName: string | null
- serverId: number
- createdAt: string
- deletedAt: string | null
pagination:
- currentPage: number
- perPage: number
- total: number
- totalFiltered: number
- totalOnPage: number
- sort:
  - by: string
  - dir:
- search: string | null

Description: Fetch punishments of a player from a specific category

Ratelimit: 5 per 10s

Scopes: punishments-moderation.read or punishments-team.read

The permission is related to the category you want to fetch.
For exemple, if you want to fetch the moderation punishments, you need the punishments-moderation.read permission

The owner of the token needs to be a moderator to fetch oral_warn punishments

The permission punishments-{{category}}.view-deleted is required to fetch deleted punishments

Required parameters

Name	Type	Description
serverId	number	The server id
uuid	string	The player uuid
category	string	The category of the punishments you want to fetch (`moderation` \| `team`)

Query parameters

Name	Type	Description	Default
active	boolean	If you want to fetch only active punishments or not	❌
type	string	The type of the punishment you want to fetch (enum: `oral_warn \| warn \| kick \| mute \| ban`)	❌
deleted	boolean	If you want to fetch only deleted punishments or not	❌
page	number	The page number (min: `1`)	1
perpage	number	The limit of elements per page (min: `1`, max: `100`)	10
search	string	The search query (only first 50 characters will be considered)	❌
sortby	string	The column to sort by	id
sortdir	string	The direction to sort by (enum: `asc \| desc`)	desc

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_ACTIVE`	The value doesn't follow the requirements
400	`INVALID_DELETED`	The value doesn't follow the requirements
400	`INVALID_PAGE`	The value doesn't follow the requirements
400	`INVALID_PERPAGE`	The value doesn't follow the requirements
400	`INVALID_PUNISHMENT_TYPE`	The value `type` doesn't follow the requirements
400	`INVALID_SEARCH`	The value doesn't follow the requirements
400	`INVALID_SERVER_ID`	The server id is invalid
400	`INVALID_SORTBY`	The value doesn't follow the requirements
400	`INVALID_SORTDIR`	The value doesn't follow the requirements
400	`INVALID_TYPE`	The value doesn't follow the requirements
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`PLAYER_NOT_FOUND`	The uuid doesn't refer to an existing player
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"
data[]:
- id: number
- category: string
- authorId: number
- author:
  - id: number
  - name: string
  - uuid: string
  - firstConnection: date
  - lastConnection: date
  - lastDashboardConnection: date | null
  - accountName: string | null
  - accountType: string
  - accountId: number
  - avatarUrl: string
  - discordUsername: string | null
  - discordDiscriminator: string | null
  - serverId: number
  - roles[]:
    - serverId: number
    - id: number
    - name: string
    - color: string
    - position: number | null
    - categories:
      - id: number
      - name: string
    - deletedAt: date | null
  - language:
    - alpha2: string
    - name: string
- targetId: number
- target:
  - id: number
  - name: string
  - uuid: string
  - firstConnection: date
  - lastConnection: date
  - lastDashboardConnection: date | null
  - accountName: string | null
  - accountType: string
  - accountId: number
  - avatarUrl: string
  - discordUsername: string | null
  - discordDiscriminator: string | null
  - serverId: number
  - roles[]:
    - serverId: number
    - id: number
    - name: string
    - color: string
    - position: number | null
    - categories:
      - id: number
      - name: string
    - deletedAt: date | null
  - language:
    - alpha2: string
    - name: string
- reason: string
- description: string | null
- gravity:
- date: string
- type:
- active: boolean | null
- duration: number | null
- teamName: string | null
- serverId: number
- createdAt: string
- deletedAt: string | null
pagination:
- currentPage: number
- perPage: number
- total: number
- totalFiltered: number
- totalOnPage: number
- sort:
  - by: string
  - dir:
- search: string | null

Description: Fetch Discord punishments for a specific player

Ratelimit: 5 per 10s

Permissions: punishments-discord.read and punishments-discord.read

Required parameters

Name	Type	Description
serverId	number	The server id
uuid	string	The player uuid

Query parameters

Name	Type	Description	Default
active	boolean	If you want to fetch only active punishments or not	❌
deleted	boolean	If you want to include deleted Discord punishments	❌
page	number	The page number (min: `1`)	1
perpage	number	The limit of elements per page (min: `1`, max: `100`)	10
search	string	The search query (only first 50 characters will be considered)	❌
sortby	string	The column to sort by	id
sortdir	string	The direction to sort by (enum: `asc \| desc`)	desc

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_ACTIVE`	The value doesn't follow the requirements
400	`INVALID_DELETED`	The value doesn't follow the requirements
400	`INVALID_PAGE`	The value doesn't follow the requirements
400	`INVALID_PERPAGE`	The value doesn't follow the requirements
400	`INVALID_SEARCH`	The value doesn't follow the requirements
400	`INVALID_SERVER_ID`	The server id is invalid
400	`INVALID_SORTBY`	The value doesn't follow the requirements
400	`INVALID_SORTDIR`	The value doesn't follow the requirements
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`PLAYER_NOT_FOUND`	The uuid doesn't refer to an existing player
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"

Description: Fetch all the punishments categories

Ratelimit: 5 per 10s

Required parameters

Name	Type	Description
serverId	number	The server id

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_SERVER_ID`	The server id is invalid
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"
data: string[]

Description: Fetch all the punishments types

Ratelimit: 5 per 10s

Required parameters

Name	Type	Description
serverId	number	The server id

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`INVALID_SERVER_ID`	The server id is invalid
401	`UNAUTHORIZED`	The token is invalid or expired
403	`ACCESS_DENIED`	The token or the author does not have the required permissions
403	`DISCORD_CONNECTION_REQUIRED`	You need a Discord account link to your Steam Account to access to the route
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"
data: string[]

GET /api/v2/:serverId/me/punishments/:category

GET /api/v2/:serverId/players/:uuid/punishments/:category

GET /api/v2/:serverId/players/:uuid/punishments/discord

GET /api/v2/:serverId/punishments/categories

GET /api/v2/:serverId/punishments/types