Description: Get events
Ratelimit: 5 per 10s
Permission: calendar_events.read

Required parameters
Name Type Description
serverId number The server id
Query parameters
Name Type Description Default
from date The date from where you want to get events (minimum: 2020-1-1) 2020-1-1
to date The date to where you want to get events (maximum: 2049-12-31) 2049-12-31
ignore-permissions boolean If you want to ignore all players permissions filters false
event-type string If you want to get only events of a specific type (enum: absence | meeting | interview | event)
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_DATE_FORMAT The date is invalid
400 INVALID_DATE_RANGE The date range must be between 2020-0-1 and 2049-11-31 and can't exceed 5184000 seconds length
400 INVALID_EVENT-TYPE The value doesn't follow the requirements
400 INVALID_FROM The value doesn't follow the requirements
400 INVALID_IGNORE-PERMISSIONS The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TO 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 CANT_IGNORE_PERMISSIONS You can't view ignore permissions you don't have the right 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
    • 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
    • serverId: number
    • title: string
    • description: string
    • category: string | null
    • fromDate: date
    • toDate: date
    • type: string
    • schedule:
      • enabled: boolean
      • endAt: date | null
      • currentEventFromDate: date | null
      • currentEventToDate: date | null
      • dayOfTheMonth: number | null
      • repeatDelay: number | null
      • dayOfTheWeek: number | null
      • weekOfTheMonth: number | null
      • monthOfTheYear: number | null
    • permissions:
      • player:
        • 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
      • selectedPresence: boolean | null
      • presence: boolean | null
      • invited: boolean
      • reason: string | null
      • late: boolean | null
      • duration: number | null
    • eventUpdates:
      • id: number
      • eventId: number
      • serverId: number
      • title: string
      • description: string
      • affectedFrom: date
      • affectedTo: date | null
      • fromDate: date | null
      • toDate: date | null
      • type: string
      • schedule:
        • enabled: boolean
        • endAt: date | null
        • currentEventFromDate: date | null
        • currentEventToDate: date | null
        • dayOfTheMonth: number | null
        • repeatDelay: number | null
        • dayOfTheWeek: number | null
        • weekOfTheMonth: number | null
        • monthOfTheYear: number | null
      • permissions:
        • player:
          • 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
        • selectedPresence: boolean | null
        • presence: boolean | null
        • invited: boolean
        • reason: string | null
        • late: boolean | null
        • duration: number | null
      • validatePresenceMinimumDelay: number | null
      • validatePresenceMaximumDelay: number | null
      • createChannelBeforeDelay: number | null
      • deleteChannelAfterDelay: number | null
      • createChannel: boolean | null
      • shareWith:
        • 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
        • badges[]:
          • id: number
          • category:
            • id: number
            • name: string
            • deletedAt: date | null
          • iconPath: string
          • fullIconPath: string
          • value: number
          • deletedAt: date | null
          • translations?:
            • name: string | null
            • description: string | null
          • addedAt: date
          • revokedAt: date | null
    • customTag:
      • color: string
    • validatePresenceMinimumDelay: number | null
    • validatePresenceMaximumDelay: number | null
    • createChannelBeforeDelay: number | null
    • deleteChannelAfterDelay: number | null
    • createChannel: boolean | null
    • createdAt: date
    • updatedAt: date
    • shareWith:
      • 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
      • badges[]:
        • id: number
        • category:
          • id: number
          • name: string
          • deletedAt: date | null
        • iconPath: string
        • fullIconPath: string
        • value: number
        • deletedAt: date | null
        • translations?:
          • name: string | null
          • description: string | null
        • addedAt: date
        • revokedAt: date | null

Description: Get an event
Ratelimit: 5 per 10s
Permission: calendar_events.read

Required parameters
Name Type Description
serverId number The server id
eventId number The event id to get
Query parameters
Name Type Description Default
target-event-from-date date If the event is a schedule event, you can specify the date of the event to get
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TARGET_EVENT_DATE The target event date is invalid
400 INVALID_TARGET-EVENT-FROM-DATE 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
404 TARGET_EVENT_NOT_FOUND The target event date was not found
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • data:
    • id: 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
    • serverId: number
    • title: string
    • description: string
    • category: string | null
    • fromDate: date
    • toDate: date
    • type: string
    • schedule:
      • enabled: boolean
      • endAt: date | null
      • currentEventFromDate: date | null
      • currentEventToDate: date | null
      • dayOfTheMonth: number | null
      • repeatDelay: number | null
      • dayOfTheWeek: number | null
      • weekOfTheMonth: number | null
      • monthOfTheYear: number | null
    • permissions:
      • player:
        • 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
      • selectedPresence: boolean | null
      • presence: boolean | null
      • invited: boolean
      • reason: string | null
      • late: boolean | null
      • duration: number | null
    • eventUpdates:
      • id: number
      • eventId: number
      • serverId: number
      • title: string
      • description: string
      • affectedFrom: date
      • affectedTo: date | null
      • fromDate: date | null
      • toDate: date | null
      • type: string
      • schedule:
        • enabled: boolean
        • endAt: date | null
        • currentEventFromDate: date | null
        • currentEventToDate: date | null
        • dayOfTheMonth: number | null
        • repeatDelay: number | null
        • dayOfTheWeek: number | null
        • weekOfTheMonth: number | null
        • monthOfTheYear: number | null
      • permissions:
        • player:
          • 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
        • selectedPresence: boolean | null
        • presence: boolean | null
        • invited: boolean
        • reason: string | null
        • late: boolean | null
        • duration: number | null
      • validatePresenceMinimumDelay: number | null
      • validatePresenceMaximumDelay: number | null
      • createChannelBeforeDelay: number | null
      • deleteChannelAfterDelay: number | null
      • createChannel: boolean | null
      • shareWith:
        • 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
        • badges[]:
          • id: number
          • category:
            • id: number
            • name: string
            • deletedAt: date | null
          • iconPath: string
          • fullIconPath: string
          • value: number
          • deletedAt: date | null
          • translations?:
            • name: string | null
            • description: string | null
          • addedAt: date
          • revokedAt: date | null
    • customTag:
      • color: string
    • validatePresenceMinimumDelay: number | null
    • validatePresenceMaximumDelay: number | null
    • createChannelBeforeDelay: number | null
    • deleteChannelAfterDelay: number | null
    • createChannel: boolean | null
    • createdAt: date
    • updatedAt: date
    • shareWith:
      • 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
      • badges[]:
        • id: number
        • category:
          • id: number
          • name: string
          • deletedAt: date | null
        • iconPath: string
        • fullIconPath: string
        • value: number
        • deletedAt: date | null
        • translations?:
          • name: string | null
          • description: string | null
        • addedAt: date
        • revokedAt: date | null

Description: Get the participants of an event
Ratelimit: 5 per 10s
Permission: calendar_events.read

Required parameters
Name Type Description
serverId number The server id
eventId number The event id to get participants
Query parameters
Name Type Description Default
target-event-from-date date If the event is a schedule event, you can specify the date of the event to get participants
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TARGET-EVENT-FROM-DATE 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[]:
    • player:
      • 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
    • selectedPresence: boolean | null
    • presence: boolean | null
    • invited: boolean
    • reason: string | null
    • late: boolean | null
    • duration: number | null

Description: Get the permissions of the current player on an event
Ratelimit: 5 per 10s
Permission: calendar_events.read

Required parameters
Name Type Description
serverId number The server id
eventId number The event id to get permissions
Query parameters
Name Type Description Default
target-event-from-date date If the event is a schedule event, you can specify the date of the event to get permissions
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TARGET-EVENT-FROM-DATE 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: string[]

Description: Get all event types list
Ratelimit: 5 per 10s
Permission: calendar_events.read

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: Get the permissions of the current player on the calendar
Ratelimit: 5 per 10s
Permission: calendar_events.read

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:
    • [categoryName]: string[]

Description: Create an event
Ratelimit: 50 per 86400s
Permission: calendar_events.create

Required parameters
Name Type Description
serverId number The server id
Required body
Key Type Description Default Required
authorUuid string The author uuid of the event Current player uuid
title string The title of the event (min length: 1, max length: 100)
description string The description of the event (min length: 1, max length: 1000)
fromDate date The start date of the event (must be in the future if you don't have the create-old-{{eventType}} permission on the selected category)
toDate date The end date of the event (must be after the start date)
type string The type of the event (enum: absence|meeting|interview|event)
validatePresenceMinimumDelay number The minimum delay before the event to validate the presence (max: 630720000)
validatePresenceMaximumDelay number The maximum delay before the event to validate the presence (max: 630720000)
category string The category of the event
dayOfTheMonth number If you want to create a schedule event, you can specify the day of the month (min: 1, max: 31)
dayOfTheWeek number If you want to create a schedule event, you can specify the day of the week (max: 6)
repeatDelay number If you want to create a schedule event, you can specify a repeat delay in seconds (min: 1, max: 630720000)
weekOfTheMonth number If you want to create a schedule event, you can specify the week of the month (starts at 0) (max: 5)
monthOfTheYear number If you want to create a schedule event, you can specify the month of the year (max: 11)
scheduleEndAt date If you want to create a schedule event, you can specify the end date of the schedule
createChannelBeforeDelay number If you want to create a channel before the event, you can specify the delay in seconds (min: 300, max: 3600)
deleteChannelAfterDelay number Specify the delay in seconds after the event start date to delete the channel when it is empty (min: 300, max: 3600)
createChannel boolean If you want to create a channel for the event, you can specify it
shareWith array The uuids of the players you want to share the event with (only for event wtih private category) (max length: 40)
participants array The participants of the interview (only for event type interview) (min length: 1, max length: 40)
Available codes
Status Code Description
200 OK The request has been successfully completed
400 BAD_BODY The request body is invalid
400 CANT_SET_CHANNEL_DELAY You can't set the channel delay if the type is not interview
400 CANT_SET_PRESENCE_DELAY You can't set the presence delay if the type is not meeting
400 FROM_DATE_MUST_BE_BEFORE_TO_DATE The from date must be before the to date
400 INVALID_AUTHOR_UUID The value authorUuid doesn't follow the requirements
400 INVALID_CATEGORY The value category doesn't follow the requirements
400 INVALID_CREATE_CHANNEL The value createChannel doesn't follow the requirements
400 INVALID_CREATE_CHANNEL_BEFORE_DELAY The value createChannelBeforeDelay doesn't follow the requirements
400 INVALID_DAY_OF_THE_MONTH The value dayOfTheMonth doesn't follow the requirements
400 INVALID_DAY_OF_THE_WEEK The value dayOfTheWeek doesn't follow the requirements
400 INVALID_DELETE_CHANNEL_AFTER_DELAY The value deleteChannelAfterDelay doesn't follow the requirements
400 INVALID_DESCRIPTION The value description doesn't follow the requirements
400 INVALID_FROM_DATE The value fromDate doesn't follow the requirements
400 INVALID_MONTH_OF_THE_YEAR The value monthOfTheYear doesn't follow the requirements
400 INVALID_PARTICIPANTS One of the participant uuid is invalid or the type is not equals to interview
400 INVALID_PARTICIPANTS The value participants doesn't follow the requirements
400 INVALID_REPEAT_DELAY The value repeatDelay doesn't follow the requirements
400 INVALID_SCHEDULE_END_AT The value scheduleEndAt doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_SHARE_WITH The value shareWith doesn't follow the requirements
400 INVALID_SHARED_PLAYER_UUID One of the shared player uuid is invalid, the same uuid of the author or the category is not equals to private
400 INVALID_TITLE The value title doesn't follow the requirements
400 INVALID_TO_DATE The value toDate doesn't follow the requirements
400 INVALID_TYPE The value type doesn't follow the requirements
400 INVALID_VALIDATE_PRESENCE_MAXIMUM_DELAY The value validatePresenceMaximumDelay doesn't follow the requirements
400 INVALID_VALIDATE_PRESENCE_MINIMUM_DELAY The value validatePresenceMinimumDelay doesn't follow the requirements
400 INVALID_WEEK_OF_THE_MONTH The value weekOfTheMonth doesn't follow the requirements
400 MISSING_AUTHOR_UUID The authorUuid value is missing
400 MISSING_BODY The request does not have a body
400 MISSING_CREATE_CHANNEL The createChannel value is missing
400 MISSING_CREATE_CHANNEL_BEFORE_DELAY The createChannelBeforeDelay value is missing
400 MISSING_CREATE_DELETE_CHANNEL_DELAY You must specify the createChannelBeforeDelay and deleteChannelAfterDelay if the createChannel is true
400 MISSING_DAY_OF_THE_MONTH The dayOfTheMonth value is missing
400 MISSING_DAY_OF_THE_WEEK The dayOfTheWeek value is missing
400 MISSING_DELETE_CHANNEL_AFTER_DELAY The deleteChannelAfterDelay value is missing
400 MISSING_MONTH_OF_THE_YEAR The monthOfTheYear value is missing
400 MISSING_PARTICIPANTS The participants value is missing
400 MISSING_REPEAT_DELAY The repeatDelay value is missing
400 MISSING_SCHEDULE_END_AT The scheduleEndAt value is missing
400 MISSING_SHARE_WITH The shareWith value is missing
400 MISSING_VALIDATE_PRESENCE_MAXIMUM_DELAY The validatePresenceMaximumDelay value is missing
400 MISSING_VALIDATE_PRESENCE_MINIMUM_DELAY The validatePresenceMinimumDelay value is missing
400 MISSING_WEEK_OF_THE_MONTH The weekOfTheMonth value is missing
400 NO_PRESENCE_DELAY You must set the presence delay if the type is meeting
400 SCHEDULE_EVENT_END_AT_MUST_BE_AFTER_TO_DATE The schedule event end at must be after the to date
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
    • 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
    • serverId: number
    • title: string
    • description: string
    • category: string | null
    • fromDate: date
    • toDate: date
    • type: string
    • schedule:
      • enabled: boolean
      • endAt: date | null
      • currentEventFromDate: date | null
      • currentEventToDate: date | null
      • dayOfTheMonth: number | null
      • repeatDelay: number | null
      • dayOfTheWeek: number | null
      • weekOfTheMonth: number | null
      • monthOfTheYear: number | null
    • permissions:
      • player:
        • 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
      • selectedPresence: boolean | null
      • presence: boolean | null
      • invited: boolean
      • reason: string | null
      • late: boolean | null
      • duration: number | null
    • eventUpdates:
      • id: number
      • eventId: number
      • serverId: number
      • title: string
      • description: string
      • affectedFrom: date
      • affectedTo: date | null
      • fromDate: date | null
      • toDate: date | null
      • type: string
      • schedule:
        • enabled: boolean
        • endAt: date | null
        • currentEventFromDate: date | null
        • currentEventToDate: date | null
        • dayOfTheMonth: number | null
        • repeatDelay: number | null
        • dayOfTheWeek: number | null
        • weekOfTheMonth: number | null
        • monthOfTheYear: number | null
      • permissions:
        • player:
          • 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
        • selectedPresence: boolean | null
        • presence: boolean | null
        • invited: boolean
        • reason: string | null
        • late: boolean | null
        • duration: number | null
      • validatePresenceMinimumDelay: number | null
      • validatePresenceMaximumDelay: number | null
      • createChannelBeforeDelay: number | null
      • deleteChannelAfterDelay: number | null
      • createChannel: boolean | null
      • shareWith:
        • 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
        • badges[]:
          • id: number
          • category:
            • id: number
            • name: string
            • deletedAt: date | null
          • iconPath: string
          • fullIconPath: string
          • value: number
          • deletedAt: date | null
          • translations?:
            • name: string | null
            • description: string | null
          • addedAt: date
          • revokedAt: date | null
    • customTag:
      • color: string
    • validatePresenceMinimumDelay: number | null
    • validatePresenceMaximumDelay: number | null
    • createChannelBeforeDelay: number | null
    • deleteChannelAfterDelay: number | null
    • createChannel: boolean | null
    • createdAt: date
    • updatedAt: date
    • shareWith:
      • 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
      • badges[]:
        • id: number
        • category:
          • id: number
          • name: string
          • deletedAt: date | null
        • iconPath: string
        • fullIconPath: string
        • value: number
        • deletedAt: date | null
        • translations?:
          • name: string | null
          • description: string | null
        • addedAt: date
        • revokedAt: date | null

Description: Update the participation of players to an event
Ratelimit: 5 per 10s
Permissions: calendar-participation.manage and calendar-participation.manage

Required parameters
Name Type Description
serverId number The server id
eventId number The event id where you want to update your participation
Required body
Key Type Structure Description Default Required
targetEventDate date If the event is a schedule event, you can specify the date of the event to update your participation
participants array
  • playerUuid: string
  • presence: boolean
  • late: boolean
  • duration: number
The participants to update
Available codes
Status Code Description
200 OK The request has been successfully completed
400 BAD_BODY The request body is invalid
400 INVALID_PARTICIPANTS The value participants doesn't follow the requirements
400 INVALID_PLAYER_UUID One of the player uuid is invalid
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TARGET_EVENT_DATE The target event date is invalid
400 INVALID_TARGET_EVENT_DATE The value targetEventDate doesn't follow the requirements
400 MISSING_BODY The request does not have a body
400 MISSING_DURATION The duration value is missing
400 MISSING_LATE The late value is missing
400 MISSING_PRESENCE The presence value is missing
400 MISSING_TARGET_EVENT_DATE The targetEventDate value is missing
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
404 TARGET_EVENT_DATE_NOT_FOUND The target event date was not found
404 TARGET_EVENT_NOT_FOUND The target event was not found
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"

Description: Update your participation to an event
Ratelimit: 5 per 10s
Permission: calendar-participation.manage

Required parameters
Name Type Description
serverId number The server id
eventId number The event id where you want to update your participation
Query parameters
Name Type Description Default
target-event-from-date date If the event is a schedule event, you can specify the date of the event to update your participation
Required body
Key Type Description Default Required
present boolean If you are present or not
reason string The reason of your absence (min length: 1, max length: 150)
Available codes
Status Code Description
200 OK The request has been successfully completed
400 BAD_BODY The request body is invalid
400 CANT_SET_REASON You can't set a reason if you are present or you want to remove your participation
400 CANT_UPDATE_PASSED_EVENT You can't update your participation to a passed event
400 INVALID_PRESENT The value present doesn't follow the requirements
400 INVALID_REASON The value reason doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TARGET-EVENT-FROM-DATE The value doesn't follow the requirements
400 MISSING_BODY The request does not have a body
400 MISSING_PRESENT The present value is missing
400 MISSING_REASON The reason value is missing
401 UNAUTHORIZED The token is invalid or expired
403 ACCESS_DENIED The token or the author does not have the required permissions
403 CANT_VALIDATE_PRESENCE_TOO_EARLY You can't validate your presence too early
403 CANT_VALIDATE_PRESENCE_TOO_LATE You can't validate your presence too late
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"

Description: Update an event
Ratelimit: 5 per 10s
Permission: calendar_events.update

Required parameters
Name Type Description
serverId number The server id
eventId number The event id to update
Query parameters
Name Type Description Default
target-event-from-date date If the event is a schedule event, you can specify the date of the event to delete
selected-event string If the event is a schedule event, you can specify if you want to delete the current event or the next ones (enum: this | next) this
Required body
Key Type Description Default Required
title string The title of the event (min length: 1, max length: 100)
description string The description of the event (min length: 1, max length: 1000)
fromDate date The start date of the event
toDate date
validatePresenceMinimumDelay number The minimum delay before the event to validate the presence (max: 630720000)
validatePresenceMaximumDelay number The maximum delay before the event to validate the presence (max: 630720000)
shareWith array The uuids of the players you want to share the event with (only for event wtih private category) (max length: 40)
participants array The participants of the interview (only for event type interview) (min length: 1, max length: 40)
dayOfTheMonth number If you want to create a schedule event, you can specify the day of the month (min: 1, max: 31)
dayOfTheWeek number If you want to create a schedule event, you can specify the day of the week (max: 6)
repeatDelay number If you want to create a schedule event, you can specify a repeat delay in seconds (min: 1, max: 630720000)
weekOfTheMonth number If you want to create a schedule event, you can specify the week of the month (starts at 0) (max: 5)
monthOfTheYear number If you want to create a schedule event, you can specify the month of the year (max: 11)
scheduleEndAt date
createChannelBeforeDelay number If you want to create a channel before the event, you can specify the delay in seconds (min: 300, max: 3600)
deleteChannelAfterDelay number Specify the delay in seconds after the event start date to delete the channel when it is empty (min: 300, max: 3600)
createChannel boolean If you want to create a channel for the event, you can specify it
Available codes
Status Code Description
200 OK The request has been successfully completed
400 BAD_BODY The request body is invalid
400 CANT_SET_CHANNEL_DELAY You can't set the channel delay if the type is not interview
400 CANT_SET_PRESENCE_DELAY You can't set the presence delay if the type is not meeting
400 CANT_UPDATE_PASSED_EVENT You can't update a passed event if you don't have the administrator global permission
400 FROM_DATE_MUST_BE_BEFORE_TO_DATE The from date must be before the to date
400 FROM_DATE_MUST_BE_IN_THE_FUTURE The from date must be in the future
400 INVALID_CREATE_CHANNEL The value createChannel doesn't follow the requirements
400 INVALID_CREATE_CHANNEL_BEFORE_DELAY The value createChannelBeforeDelay doesn't follow the requirements
400 INVALID_DAY_OF_THE_MONTH The value dayOfTheMonth doesn't follow the requirements
400 INVALID_DAY_OF_THE_WEEK The value dayOfTheWeek doesn't follow the requirements
400 INVALID_DELETE_CHANNEL_AFTER_DELAY The value deleteChannelAfterDelay doesn't follow the requirements
400 INVALID_DESCRIPTION The value description doesn't follow the requirements
400 INVALID_FROM_DATE The value fromDate doesn't follow the requirements
400 INVALID_MONTH_OF_THE_YEAR The value monthOfTheYear doesn't follow the requirements
400 INVALID_PARTICIPANTS The value participants doesn't follow the requirements
400 INVALID_REPEAT_DELAY The value repeatDelay doesn't follow the requirements
400 INVALID_SCHEDULE_END_AT The value scheduleEndAt doesn't follow the requirements
400 INVALID_SELECTED-EVENT The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_SHARE_WITH The value shareWith doesn't follow the requirements
400 INVALID_SHARED_PLAYER_UUID One of the shared player uuid is invalid, the same uuid of the author or the category is not equals to private
400 INVALID_TARGET_EVENT_DATE The target event date is invalid
400 INVALID_TARGET-EVENT-FROM-DATE The value doesn't follow the requirements
400 INVALID_TITLE The value title doesn't follow the requirements
400 INVALID_TO_DATE The value toDate doesn't follow the requirements
400 INVALID_VALIDATE_PRESENCE_MAXIMUM_DELAY The value validatePresenceMaximumDelay doesn't follow the requirements
400 INVALID_VALIDATE_PRESENCE_MINIMUM_DELAY The value validatePresenceMinimumDelay doesn't follow the requirements
400 INVALID_WEEK_OF_THE_MONTH The value weekOfTheMonth doesn't follow the requirements
400 MISSING_BODY The request does not have a body
400 MISSING_CREATE_CHANNEL The createChannel value is missing
400 MISSING_CREATE_CHANNEL_BEFORE_DELAY The createChannelBeforeDelay value is missing
400 MISSING_DAY_OF_THE_MONTH The dayOfTheMonth value is missing
400 MISSING_DAY_OF_THE_WEEK The dayOfTheWeek value is missing
400 MISSING_DELETE_CHANNEL_AFTER_DELAY The deleteChannelAfterDelay value is missing
400 MISSING_MONTH_OF_THE_YEAR The monthOfTheYear value is missing
400 MISSING_PARTICIPANTS The participants value is missing
400 MISSING_REPEAT_DELAY The repeatDelay value is missing
400 MISSING_SCHEDULE_END_AT The scheduleEndAt value is missing
400 MISSING_SHARE_WITH The shareWith value is missing
400 MISSING_VALIDATE_PRESENCE_MAXIMUM_DELAY The validatePresenceMaximumDelay value is missing
400 MISSING_VALIDATE_PRESENCE_MINIMUM_DELAY The validatePresenceMinimumDelay value is missing
400 MISSING_WEEK_OF_THE_MONTH The weekOfTheMonth value is missing
400 NO_PRESENCE_DELAY You must set the presence delay if the type is meeting
400 SCHEDULE_EVENT_END_AT_MUST_BE_AFTER_TO_DATE The schedule event end at must be after the to date
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
404 TARGET_EVENT_DATE_NOT_FOUND The target event date was not found
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"
  • newEvent:
    • id: 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
    • serverId: number
    • title: string
    • description: string
    • category: string | null
    • fromDate: date
    • toDate: date
    • type: string
    • schedule:
      • enabled: boolean
      • endAt: date | null
      • currentEventFromDate: date | null
      • currentEventToDate: date | null
      • dayOfTheMonth: number | null
      • repeatDelay: number | null
      • dayOfTheWeek: number | null
      • weekOfTheMonth: number | null
      • monthOfTheYear: number | null
    • permissions:
      • player:
        • 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
      • selectedPresence: boolean | null
      • presence: boolean | null
      • invited: boolean
      • reason: string | null
      • late: boolean | null
      • duration: number | null
    • eventUpdates:
      • id: number
      • eventId: number
      • serverId: number
      • title: string
      • description: string
      • affectedFrom: date
      • affectedTo: date | null
      • fromDate: date | null
      • toDate: date | null
      • type: string
      • schedule:
        • enabled: boolean
        • endAt: date | null
        • currentEventFromDate: date | null
        • currentEventToDate: date | null
        • dayOfTheMonth: number | null
        • repeatDelay: number | null
        • dayOfTheWeek: number | null
        • weekOfTheMonth: number | null
        • monthOfTheYear: number | null
      • permissions:
        • player:
          • 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
        • selectedPresence: boolean | null
        • presence: boolean | null
        • invited: boolean
        • reason: string | null
        • late: boolean | null
        • duration: number | null
      • validatePresenceMinimumDelay: number | null
      • validatePresenceMaximumDelay: number | null
      • createChannelBeforeDelay: number | null
      • deleteChannelAfterDelay: number | null
      • createChannel: boolean | null
      • shareWith:
        • 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
        • badges[]:
          • id: number
          • category:
            • id: number
            • name: string
            • deletedAt: date | null
          • iconPath: string
          • fullIconPath: string
          • value: number
          • deletedAt: date | null
          • translations?:
            • name: string | null
            • description: string | null
          • addedAt: date
          • revokedAt: date | null
    • customTag:
      • color: string
    • validatePresenceMinimumDelay: number | null
    • validatePresenceMaximumDelay: number | null
    • createChannelBeforeDelay: number | null
    • deleteChannelAfterDelay: number | null
    • createChannel: boolean | null
    • createdAt: date
    • updatedAt: date
    • shareWith:
      • 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
      • badges[]:
        • id: number
        • category:
          • id: number
          • name: string
          • deletedAt: date | null
        • iconPath: string
        • fullIconPath: string
        • value: number
        • deletedAt: date | null
        • translations?:
          • name: string | null
          • description: string | null
        • addedAt: date
        • revokedAt: date | null

Description: Delete an event
Ratelimit: 5 per 10s
Permission: calendar_events.delete

Required parameters
Name Type Description
serverId number The server id
eventId number The event id to delete
Query parameters
Name Type Description Default
target-event-from-date date If the event is a schedule event, you can specify the date of the event to delete
selected-event string If the event is a schedule event, you can specify if you want to delete the current event or the next ones (enum: this | next) this
Available codes
Status Code Description
200 OK The request has been successfully completed
400 INVALID_SELECTED-EVENT The value doesn't follow the requirements
400 INVALID_SERVER_ID The server id is invalid
400 INVALID_TARGET_EVENT_DATE The target event date is invalid
400 INVALID_TARGET-EVENT-FROM-DATE 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
404 TARGET_EVENT_NOT_FOUND The target event date was not found
500 INTERNAL_ERROR An internal error has occured
Response structure
  • code: "OK"