Description: Fetch a player by his Discord id
Ratelimit: 5 per 10s
Permission: player.read
Required parameters
Name Type Description
serverId number The server id
guildId string The Discord guild id where you wan't to fetch the member
userId string The Discord user id of the member you wan't to fetch
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 MEMBER_NOT_FOUND We didn't found any member with this user id
404 PLAYER_NOT_FOUND We didn't found any player with this member
404 SERVER_NOT_FOUND We didn't found any server with this guild id
404 SERVER_NOT_FOUND The server does not exist
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • data:
    • 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

Description: Fetch the players list
Ratelimit: 5 per 10s
Permission: player.read
Required parameters
Name Type Description
serverId number The server id
Query parameters
Name Type Description Default
from date The start date to fetch the players list ❌
online boolean Fetch only the online players ❌
permission string Fetch only the players with the specified permissions ❌
teamManagementCategories string Fetch only the players with the specified team management categories (separated by a comma) ❌
allowAdministrators boolean Only work if teamManagementCategories is specified (allow to fetch the administrators) else, it will be ignored ❌
ticketType string Fetch only the players which have an access to a specific ticket type ❌
small boolean If you want the minimum of informations possible (id, name, serverId, uuid, avatarUrl, accountType) ❌
uuids string To search players by their uuids (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_ALLOW_ADMINISTRATORS The value doesn't follow the requirements
400 INVALID_FROM The value doesn't follow the requirements
400 INVALID_ONLINE The value doesn't follow the requirements
400 INVALID_PAGE The value doesn't follow the requirements
400 INVALID_PERMISSION 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_SMALL The value doesn't follow the requirements
400 INVALID_SORTBY The value doesn't follow the requirements
400 INVALID_SORTDIR The value doesn't follow the requirements
400 INVALID_TEAM_MANAGEMENT_CATEGORIES The value doesn't follow the requirements
400 INVALID_TEAM_MANAGEMENT_CATEGORY The team management category doesn't exists
400 INVALID_TICKET_TYPE The value doesn't follow the requirements
400 INVALID_UUIDS 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
    • 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
  • pagination:
    • currentPage: number
    • perPage: number
    • total: number
    • totalFiltered: number
    • totalOnPage: number
    • sort:
      • by: string
      • dir:
    • search: string | null

Description: Fetch a player by his UUID
Ratelimit: 5 per 10s
Permission: player.read
Required parameters
Name Type Description
serverId number The server id
uuid string The player uuid
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 PLAYER_NOT_FOUND The player was not found
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
    • 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