Documentation - KB RolePlay

Description: Fetch an application

Ratelimit: 5 per 10s

Permission: applications.fetch

You need to have the write value to true on the permissions fetch route to access to this route

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category of the application to fetch
applicationId	number	The id of the application to fetch

Query parameters

Name	Type	Description	Default
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_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	`NOT_FOUND`	The application does not exist
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
- authorName: string
- 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
- closerId: number
- closer:
  - 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
- canDoAnotherAt: date | null
- closedAt: date | null
- status: string
- createdAt: date | null
- position: string | null
- waitingEdit: boolean | null
pagination:
- currentPage: number
- perPage: number
- total: number
- totalFiltered: number
- totalOnPage: number
- sort:
  - by: string
  - dir:
- search: string | null

Description: Fetch all applications by category

Ratelimit: 5 per 10s

Permission: applications.fetch

You need to have the write value to true on the permissions fetch route to access to this route

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category of the applications to fetch

Query parameters

Name	Type	Description	Default
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_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	`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
- authorName: string
- 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
- closerId: number
- closer:
  - 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
- canDoAnotherAt: date | null
- closedAt: date | null
- status: string
- createdAt: date | null
- position: string | null
- waitingEdit: boolean | null
pagination:
- currentPage: number
- perPage: number
- total: number
- totalFiltered: number
- totalOnPage: number
- sort:
  - by: string
  - dir:
- search: string | null

Description: Fetch assigned applications by category

Ratelimit: 5 per 10s

Permission: applications.fetch

You need to have the write value to true on the permissions fetch route to access to this route

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category of the applications to fetch

Query parameters

Name	Type	Description	Default
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_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	`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
- authorName: string
- 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
- closerId: number
- closer:
  - 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
- canDoAnotherAt: date | null
- closedAt: date | null
- status: string
- createdAt: date | null
- position: string | null
- waitingEdit: boolean | null
pagination:
- currentPage: number
- perPage: number
- total: number
- totalFiltered: number
- totalOnPage: number
- sort:
  - by: string
  - dir:
- search: string | null

Description: Fetch categories

Ratelimit: 5 per 10s

Permission: applications.fetch

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 applications permissions

Ratelimit: 5 per 10s

Permission: applications.fetch

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[]:
- name: string
- manage: boolean
- write: boolean

Description: Process an application

Ratelimit: 5 per 10s

Permission: applications.manage

You need to have the manage value to true on the permissions fetch route to access to this route

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category of the application to fetch
applicationId	number	The id of the application to fetch

Required body

Key	Type	Description	Default	Required
content	string	The content of your message (min length: `10`, max length: `10000`)	❌	✅
position	string	Your position on the application (if you want to accept, deny) (enum: `accept\|deny`)	❌	✅
response	string	The response type	❌	✅

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`BAD_BODY`	The request body is invalid
400	`INVALID_CONTENT`	The value `content` doesn't follow the requirements
400	`INVALID_POSITION`	The value `position` doesn't follow the requirements
400	`INVALID_RESPONSE`	The response type does not exist
400	`INVALID_RESPONSE`	The value `response` doesn't follow the requirements
400	`INVALID_SERVER_ID`	The server id is invalid
400	`MISSING_BODY`	The request does not have a body
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	`NOT_FOUND`	The application does not exist
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"

Description: Reply to an application

Ratelimit: 5 per 10s

Permission: applications.reply

You need to have the write value to true on the permissions fetch route to access to this route

Required parameters

Name	Type	Description
serverId	number	The server id

Required body

Key	Type	Structure	Description	Default	Required
content	string	❌	The content of your message (min length: `10`, max length: `10000`)	❌	✅
standards	array	name: `string` selected: `string`	The standards	❌	✅

Available codes

Status	Code	Description
200	`OK`	The request has been successfully completed
400	`BAD_BODY`	The request body is invalid
400	`INVALID_CONTENT`	The value `content` doesn't follow the requirements
400	`INVALID_SERVER_ID`	The server id is invalid
400	`INVALID_STANDARD`	The standard does not exist
400	`INVALID_STANDARDS`	The value `standards` doesn't follow the requirements
400	`MISSING_BODY`	The request does not have a body
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	`NOT_FOUND`	The application does not exist
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"

Description: Delete a reply

Ratelimit: 5 per 10s

Permission: applications.delete-reply

You need to have the manage value to true on the permissions fetch route to access to this route

You can't delete a reply if the application is closed

Required parameters

Name	Type	Description
serverId	number	The server id
category	string	The category of the application to fetch
applicationId	number	The id of the application to fetch
messageId	number	The id of the message to delete

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	`NOT_FOUND`	The application or the message does not exist
404	`SERVER_NOT_FOUND`	The server does not exist
500	`INTERNAL_ERROR`	An internal error has occured

Response structure

code: "OK"

GET /api/v2/:serverId/applications/:category/:applicationId

GET /api/v2/:serverId/applications/:category/all

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

GET /api/v2/:serverId/applications/categories

GET /api/v2/:serverId/applications/permissions

POST /api/v2/:serverId/applications/:category/:applicationId/process

POST /api/v2/:serverId/applications/:category/:applicationId/reply

DELETE /api/v2/:serverId/applications/:category/:applicationId/messages/:messageId