Models

Every data shape the website’s API sends or accepts, generated from the OpenAPI schema’s components/schemas. Operation pages link to these entries instead of repeating field tables.

ActivityAck

Field	Type	Required	Description
ids	array of string (uuid)	yes

AddonCreate

Field	Type	Required	Description
slug	string	yes
name	string	yes
summary	string	yes
version	string	yes
download_url	string	yes
homepage_url	string | null	no
origin	AddonOrigin	no

AddonOrigin

Who made the addon: the guild itself, or a community addon it recommends.

Type: string

AddonSchema

Field	Type	Required	Description
id	string (uuid)	yes
slug	string	yes
name	string	yes
summary	string	yes
version	string	yes
download_url	string	yes
homepage_url	string | null	yes
origin	AddonOrigin	no
updated_at	string (date-time)	yes

AddonUpdate

Field	Type	Required	Description
name	string | null	no
summary	string | null	no
version	string | null	no
download_url	string | null	no
homepage_url	string | null	no
origin	AddonOrigin | null	no

AnnouncementImportCounts

Field	Type	Required	Description
new	integer	no

AnnouncementPosted

Field	Type	Required	Description
message_id	integer	yes

AnnouncementPostedResult

Field	Type	Required	Description
message_id	integer	yes

AnnouncementSource

Where an announcement was made.

Type: string

AttendanceDetail

Field	Type	Required	Description
event	AttendanceEventSummary	yes
signups	array of AttendanceSignup	yes
walk_in_candidates	array of WalkInCandidate	yes

AttendanceEventSummary

Field	Type	Required	Description
id	string (uuid)	yes
title	string	yes
kind	EventKind	yes
starts_at	string (date-time)	yes
status	EventStatus	yes
attendance_taken_at	string (date-time) | null	yes
needs_attendance	boolean	yes

AttendanceMark

Field	Type	Required	Description
entries	array of AttendanceMarkEntry	no
walk_ins	array of WalkInCreate	no

AttendanceMarkEntry

Field	Type	Required	Description
signup_id	string (uuid)	yes
attended	boolean	yes

AttendanceRange

A reporting window for GET /api/attendance/report and /trends.

Type: string

AttendanceReport

Field	Type	Required	Description
range	AttendanceRange	yes
raids_only	boolean	yes
rows	array of MemberAttendanceRow	yes

AttendanceSignup

Field	Type	Required	Description
signup_id	string (uuid)	yes
member_id	integer	yes
display_name	string	yes
avatar_url	string | null	yes
character	string | null	yes
class	WowClass | null	yes
role	SignupRole | null	yes
status	SignupStatus	yes
attended	boolean | null	yes
is_walk_in	boolean	yes
voice_minutes	integer	yes
suggested_attended	boolean	yes

AttendanceTrendPoint

Field	Type	Required	Description
week_start	string (date)	yes
attendees	integer	yes
signed_up	integer	yes
show_rate	number	yes

AttendanceTrends

Field	Type	Required	Description
range	AttendanceRange	yes
raids_only	boolean	yes
points	array of AttendanceTrendPoint	yes

AwardImportCounts

Field	Type	Required	Description
new	integer	no
updated	integer	no
voided	integer	no

AwayNowReport

Field	Type	Required	Description
discord_ids	array of integer	yes

AwayRangeIn

Field	Type	Required	Description
start_date	string (date)	yes
end_date	string (date)	yes
note	string | null	no

AwayRangeSchema

Field	Type	Required	Description
id	string (uuid)	yes
start_date	string (date)	yes
end_date	string (date)	yes
note	string | null	yes

BadgeAck

Field	Type	Required	Description
discord_id	integer	yes
badge_id	string	yes

BadgeRoleState

Field	Type	Required	Description
discord_id	integer	yes
badge_ids	array of string	yes

BadgeSyncReport

Field	Type	Required	Description
role_state	array of BadgeRoleState	yes
pending	array of PendingBadgeAnnouncement	yes

BankImportCounts

Field	Type	Required	Description
new	integer	no

BankKind

What kind of guild bank activity log row this is.

Type: string

CalendarLink

Field	Type	Required	Description
token	string	yes
url	string	yes

CaseAction

Kinds of moderation action recorded as cases.

Type: string

CharacterSource

How a WowCharacter got linked to a member.

Type: string

ChartUpdate

Field	Type	Required	Description
group	integer | null	no
bench	boolean | null	no

ConfirmByDiscordRequest

Field	Type	Required	Description
actor_discord_id	string	yes
actor_name	string	yes

DiscordEventPush

Field	Type	Required	Description
event_id	string (uuid)	yes
discord_event_id	integer | null	yes
thread_id	integer | null	no	The event’s forum thread, if one has been created.
kind	EventKind	yes
counts	EventCounts	no	Current headcounts, for the forum starter post’s live counts line.
action	string	yes
name	string	yes
title	string	yes	Full, untruncated title (name is Discord’s 100-char-limited version).
description	string	yes
location	string	yes	Used for external events; voice/stage events keep theirs.
starts_at	string (date-time)	yes
ends_at	string (date-time)	yes	Discord requires an end for external events.
signup_url	string	yes
push_hash	string	yes

DiscordEventReconcile

Field	Type	Required	Description
events	array of DiscordEventState	yes

DiscordEventState

Field	Type	Required	Description
id	integer	yes
name	string	yes
description	string | null	no
starts_at	string (date-time)	yes
ends_at	string (date-time) | null	no
status	DiscordEventStatus	yes
location	string | null	no	External events only.
channel_id	integer | null	no	Voice/stage events only.

DiscordEventStatus

A Discord scheduled event’s status, named the way Discord’s EventStatus is.

Type: string

DiscordInterest

Field	Type	Required	Description
count	integer	yes
members	array of SignupMember	yes

DiscordInterestReport

Field	Type	Required	Description
user_ids	array of integer	yes

DiscordLive

Field	Type	Required	Description
online	integer | null	yes
members	integer | null	yes
voice	array of VoiceChannelCount	yes
reported_at	string (date-time) | null	yes

DiscordLiveReport

Field	Type	Required	Description
online	integer | null	no
members	integer | null	no
voice	array of VoiceChannelCount	yes

DiscordOnline

Field	Type	Required	Description
presence_count	integer | null	yes
members	array of DiscordOnlineMember	yes
ok	boolean	yes

DiscordOnlineMember

Field	Type	Required	Description
name	string	yes
status	string	yes
avatar_url	string | null	yes
activity	string | null	yes

DiscordPushAck

Field	Type	Required	Description
push_hash	string	yes
event	DiscordEventState | null	yes
thread_id	integer | null	no

DiscordSyncPending

Field	Type	Required	Description
pushes	array of DiscordEventPush	yes
deletions	array of integer	yes	Discord event ids whose guild event was deleted on the site.
activity	array of SignupActivity	no	Unposted sign-up activity for events with a Discord thread, oldest first.

EarnedBadge

Field	Type	Required	Description
id	string	yes
name	string	yes
description	string	yes
icon	string	yes
earned_at	string (date-time)	yes

EpgpAdjustmentCreate

Field	Type	Required	Description
member_id	integer	yes
kind	LedgerKind	yes
amount	integer	yes
reason	string	yes

EpgpCharacter

Field	Type	Required	Description
id	string (uuid)	yes
name	string	yes
realm	string	yes
class	WowClass | null	yes
member_id	integer | null	yes
member_name	string | null	yes
is_main	boolean	yes
source	CharacterSource	yes
last_seen_at	string (date-time) | null	yes

EpgpCharacterList

Field	Type	Required	Description
characters	array of EpgpCharacter	yes

EpgpCharacterUpdate

Field	Type	Required	Description
member_id	integer | null	yes
is_main	boolean	yes

EpgpGameImport

Field	Type	Required	Description
payload	string	yes
generated_at	string (date-time)	yes

EpgpImportBody

Field	Type	Required	Description
payload	string	yes

EpgpImportResult

Field	Type	Required	Description
recorder	string	yes
sessions	ImportCounts	yes
encounters	ImportCounts	yes
loot	LootImportCounts	yes
awards	AwardImportCounts	yes
unlinked_characters	array of string	no
attendance	ImportAttendanceResult	yes
conflicts	array of string	no
roster	RosterImportCounts	no
professions	ProfessionImportCounts	no
signups	SignupImportCounts	no
bank	BankImportCounts	no
announcements	AnnouncementImportCounts	no
recruits	RecruitImportCounts	no
member_notes	MemberNoteImportCounts	no

EpgpLedgerPage

Field	Type	Required	Description
entries	array of EpgpLedgerRow	yes

EpgpLedgerRow

Field	Type	Required	Description
id	string (uuid)	yes
at	string (date-time)	yes
kind	LedgerKind	yes
amount	integer	yes
decayed	number	yes
reason	string	yes
note	string | null	yes
character	string | null	yes
member_id	integer | null	yes
member_name	string | null	yes
officer	string	yes
item_name	string | null	yes
voided	boolean	yes

EpgpLootPage

Field	Type	Required	Description
items	array of EpgpLootRow	yes

EpgpLootRow

Field	Type	Required	Description
id	string (uuid)	yes
at	string (date-time)	yes
item_id	integer	yes
item_name	string	yes
quality	integer	yes
character	string | null	yes
member_id	integer | null	yes
member_name	string | null	yes
response	LootResponse	yes
gp	integer	yes
instance_name	string | null	yes
encounter_name	string | null	yes
voided	boolean	yes

EpgpMemberNoteList

Field	Type	Required	Description
notes	array of EpgpMemberNoteRow	yes

EpgpMemberNoteRow

Field	Type	Required	Description
id	string (uuid)	yes
character	string	yes
member_id	integer | null	yes
note	string	yes
officer	string	yes
at	string (date-time)	yes
voided	boolean	yes

EpgpProgression

Field	Type	Required	Description
instances	array of EpgpProgressionInstance	yes

EpgpProgressionEncounter

Field	Type	Required	Description
encounter_id	integer	yes
name	string	yes
first_kill_at	string (date-time) | null	yes
kills	integer	yes
wipes	integer	yes
last_attempt_at	string (date-time)	yes

EpgpProgressionInstance

Field	Type	Required	Description
instance_id	integer	yes
name	string	yes
size	integer	yes
encounters	array of EpgpProgressionEncounter	yes

EpgpRecruitList

Field	Type	Required	Description
recruits	array of EpgpRecruitRow	yes

EpgpRecruitRow

Field	Type	Required	Description
id	string (uuid)	yes
character	string	yes
class	WowClass | null	no
status	RecruitStatus	yes
note	string | null	yes
checklist	RecruitChecklist	yes
votes	array of ExportRecruitVote	yes
member_id	integer | null	yes
at	string (date-time)	yes

EpgpRecruitUpdate

Field	Type	Required	Description
status	RecruitStatus | null	no
note	string | null	no
checklist	RecruitChecklist | null	no

EpgpRecruitVoteCreate

Field	Type	Required	Description
vote	RecruitVoteChoice	yes

EpgpRoster

Field	Type	Required	Description
members	array of EpgpRosterRow	yes

EpgpRosterRow

Field	Type	Required	Description
member_id	integer	yes
name	string	yes
raid_status	RaidStatus | null	yes
trial_started_at	string (date-time) | null	yes

EpgpRosterUpdate

Field	Type	Required	Description
raid_status	RaidStatus | null	yes

EpgpRules

Field	Type	Required	Description
ep	object	yes
gp	object	yes
chase_multiplier	number	yes
legendary_gp	integer	yes
os_percent	integer	yes
base_gp	integer	yes
min_gp	integer	yes
decay_percent	integer	yes
trial_days	integer	yes

EpgpStandings

Field	Type	Required	Description
generated_at	string (date-time)	yes
rules	EpgpRules	yes
rows	array of EpgpStandingsRow	yes

EpgpStandingsRow

Field	Type	Required	Description
member_id	integer | null	yes
name	string	yes
main	string | null	yes
class	WowClass | null	yes
characters	array of string	yes
ep	number	yes
gp	number	yes
pr	number	yes
trial	boolean	yes

EpgpSyncTokenCreate

Field	Type	Required	Description
name	string	yes

EpgpSyncTokenCreated

Field	Type	Required	Description
id	string (uuid)	yes
name	string	yes
token	string	yes

EpgpSyncTokenList

Field	Type	Required	Description
tokens	array of EpgpSyncTokenSummary	yes

EpgpSyncTokenSummary

Field	Type	Required	Description
id	string (uuid)	yes
name	string	yes
created_at	string (date-time)	yes
last_used_at	string (date-time) | null	yes

EventCounts

Current headcounts, for the forum starter post’s live counts line.

Field	Type	Required	Description
tank	integer	yes
healer	integer	yes
dps	integer	yes
signed	integer	yes
tentative	integer	yes
absent	integer	yes
interested	integer	yes

EventCreate

Field	Type	Required	Description
kind	EventKind	yes
title	string	yes
location	string	no
starts_at	string (date-time)	yes
ends_at	string (date-time) | null	no
size	integer | null	no
ep_override	integer | null	no
notes	string | null	no

EventDetail

Field	Type	Required	Description
id	string (uuid)	yes
kind	EventKind	yes
title	string	yes
location	string	yes
starts_at	string (date-time)	yes
ends_at	string (date-time) | null	yes
size	integer | null	yes
ep	integer	yes
ep_override	integer | null	yes
status	EventStatus	yes
notes	string | null	yes
counts	EventCounts | null	yes
series	SeriesRef | null	yes
signups	array of Signup	yes
my_signup	Signup | null	yes
discord_interest	DiscordInterest | null	yes
away	array of SignupMember | null	yes

EventKind

What kind of guild event this is. raid/dungeon are “role kinds”: sign-ups need character/class/role.

Type: string

EventSeriesCreate

Field	Type	Required	Description
kind	EventKind	yes
title	string	yes
location	string	no
size	integer | null	no
ep_override	integer | null	no
notes	string | null	no
weekdays	array of integer	yes
interval_weeks	integer	no
start_time	string	yes
timezone	string	yes
duration_minutes	integer | null	no
starts_on	string (date)	yes
until	string (date) | null	no

EventSeriesSummary

Field	Type	Required	Description
id	string (uuid)	yes
kind	EventKind	yes
title	string	yes
location	string	yes
size	integer | null	yes
ep	integer	yes
ep_override	integer | null	yes
notes	string | null	yes
rule	SeriesRule	yes
active	boolean	yes
next_starts_at	string (date-time) | null	yes

EventSeriesUpdate

Field	Type	Required	Description
kind	EventKind | null	no
title	string | null	no
location	string | null	no
size	integer | null	no
ep_override	integer | null	no
notes	string | null	no
weekdays	array of integer | null	no
interval_weeks	integer | null	no
start_time	string | null	no
timezone	string | null	no
duration_minutes	integer | null	no
starts_on	string (date) | null	no
until	string (date) | null	no

EventStatus

Lifecycle of a scheduled guild event.

Type: string

EventSummary

Field	Type	Required	Description
id	string (uuid)	yes
kind	EventKind	yes
title	string	yes
location	string	yes
starts_at	string (date-time)	yes
ends_at	string (date-time) | null	yes
size	integer | null	yes
ep	integer	yes
ep_override	integer | null	yes
status	EventStatus	yes
notes	string | null	yes
counts	EventCounts | null	yes
series	SeriesRef | null	yes

EventUpdate

Field	Type	Required	Description
kind	EventKind | null	no
title	string | null	no
location	string | null	no
starts_at	string (date-time) | null	no
ends_at	string (date-time) | null	no
size	integer | null	no
ep_override	integer | null	no
notes	string | null	no
status	EventStatus | null	no

ExportRecruitVote

Field	Type	Required	Description
officer	string	yes
vote	RecruitVoteChoice	yes
at	integer	yes

GmCase

Field	Type	Required	Description
case_number	integer	yes
action	string	yes
user_id	string	yes
user_name	string | null	yes
moderator_id	string	yes
moderator_name	string | null	yes
reason	string | null	yes
duration_seconds	integer | null	yes
created_at	string (date-time)	yes

GmCaseReasonUpdate

Field	Type	Required	Description
reason	string	yes

GmMember

Field	Type	Required	Description
id	integer	yes
discord_id	string	yes
username	string	yes
display_name	string	yes
avatar_url	string | null	yes
roles	array of RoleTag	yes
is_guild_member	boolean	yes
is_officer	boolean	yes
is_gm	boolean	yes
roster_confirmed_at	string (date-time) | null	yes
battletag	string | null	yes
battlenet_linked_at	string (date-time) | null	yes
first_seen_at	string (date-time)	yes
last_login_at	string (date-time) | null	yes
signup_count	integer	yes
case_count	integer	yes
level	integer | null	yes

GmMemberDetail

Field	Type	Required	Description
member	GmMember	yes
signups	array of GmSignup	yes
cases	array of GmCase	yes
xp	integer | null	yes
message_count	integer | null	yes

GmSignup

Field	Type	Required	Description
event_id	string (uuid)	yes
title	string	yes
kind	string	yes
starts_at	string (date-time)	yes
event_status	string	yes
status	string	yes
character	string | null	yes
class	string | null	yes
role	string | null	yes
comment	string | null	yes

GuildAnnouncementCreate

Field	Type	Required	Description
text	string	yes
discord	boolean	no

GuildAnnouncementRow

Field	Type	Required	Description
id	string (uuid)	yes
text	string	yes
author	string	yes
at	string (date-time)	yes
source	AnnouncementSource	yes
posted_at	string (date-time) | null	yes

GuildAnnouncementsPage

Field	Type	Required	Description
items	array of GuildAnnouncementRow	yes

GuildBankPage

Field	Type	Required	Description
rows	array of GuildBankRow	yes
totals	GuildBankTotals	yes

GuildBankRow

Field	Type	Required	Description
id	string (uuid)	yes
at	string (date-time)	yes
character	string | null	yes
member_name	string | null	yes
kind	BankKind	yes
item_id	integer | null	yes
item_name	string | null	yes
count	integer	yes
money	integer	yes
tab	integer | null	yes

GuildBankTotals

Field	Type	Required	Description
deposits_30d	integer	yes
withdrawals_30d	integer	yes

GuildConfigSchema

Field	Type	Required	Description
guild_id	integer	yes
log_channel_id	integer | null	yes
welcome_channel_id	integer | null	yes
welcome_message	string	yes
auto_role_id	integer | null	yes
linked_role_id	integer | null	no
battlenet_role_id	integer | null	no
gate_role_id	integer | null	no
roster_role_id	integer | null	no
events_forum_channel_id	integer | null	no
leveling_enabled	boolean	yes
level_up_channel_id	integer | null	yes
level_up_message	string	yes
xp_min	integer	yes
xp_max	integer	yes
xp_cooldown_seconds	integer	yes
level_roles_stack	boolean	yes
no_xp_channel_ids	array of integer	yes
no_xp_role_ids	array of integer	yes
automod_enabled	boolean	yes
automod_block_invites	boolean	yes
automod_block_links	boolean	yes
automod_max_mentions	integer	yes
automod_spam_messages	integer	yes
automod_spam_seconds	integer	yes
automod_timeout_seconds	integer	yes
automod_exempt_role_ids	array of integer	yes
automod_exempt_channel_ids	array of integer	yes
signup_notice_channel_id	integer | null	no
weekly_board_channel_id	integer | null	no
weekly_board_last_week	string | null	no
away_role_id	integer | null	no
badge_channel_id	integer | null	no
badge_role_ids	object	no
announcement_channel_id	integer | null	no
forever_feed_channel_id	integer | null	no

GuildConfigUpdate

Field	Type	Required	Description
log_channel_id	integer | null	no
welcome_channel_id	integer | null	no
welcome_message	string | null	no
auto_role_id	integer | null	no
linked_role_id	integer | null	no
battlenet_role_id	integer | null	no
gate_role_id	integer | null	no
roster_role_id	integer | null	no
events_forum_channel_id	integer | null	no
leveling_enabled	boolean | null	no
level_up_channel_id	integer | null	no
level_up_message	string | null	no
xp_min	integer | null	no
xp_max	integer | null	no
xp_cooldown_seconds	integer | null	no
level_roles_stack	boolean | null	no
no_xp_channel_ids	array of integer | null	no
no_xp_role_ids	array of integer | null	no
automod_enabled	boolean | null	no
automod_block_invites	boolean | null	no
automod_block_links	boolean | null	no
automod_max_mentions	integer | null	no
automod_spam_messages	integer | null	no
automod_spam_seconds	integer | null	no
automod_timeout_seconds	integer | null	no
automod_exempt_role_ids	array of integer | null	no
automod_exempt_channel_ids	array of integer | null	no
signup_notice_channel_id	integer | null	no
weekly_board_channel_id	integer | null	no
weekly_board_last_week	string | null	no
away_role_id	integer | null	no
badge_channel_id	integer | null	no
badge_role_ids	object | null	no
announcement_channel_id	integer | null	no
forever_feed_channel_id	integer | null	no

GuildCrafterProfessionCount

Field	Type	Required	Description
profession	string	yes
crafters	integer	yes

GuildCrafterResult

Field	Type	Required	Description
recipe_id	integer	yes
recipe_name	string	yes
item_id	integer | null	yes
crafters	array of GuildCrafterRow	yes

GuildCrafterRow

Field	Type	Required	Description
character	string	yes
member_id	integer | null	yes
member_name	string | null	yes
profession	string	yes
skill	integer	yes

GuildCrafters

Field	Type	Required	Description
results	array of GuildCrafterResult	yes
professions	array of GuildCrafterProfessionCount	yes

GuildNewsItem

Field	Type	Required	Description
id	string (uuid)	yes
at	string (date-time)	yes
kind	NewsKind	yes
text	string	yes
character	string | null	yes
item_id	integer | null	yes
quality	integer | null	yes

GuildNewsPage

Field	Type	Required	Description
items	array of GuildNewsItem	yes

GuildRoleIn

Field	Type	Required	Description
id	integer	yes
name	string	yes
color	integer	yes
position	integer	yes
managed	boolean	yes

GuildRolesReplace

Field	Type	Required	Description
roles	array of GuildRoleIn	yes

GuildRoster

Field	Type	Required	Description
taken_at	string (date-time) | null	yes
members	array of GuildRosterMember	yes
unlinked	array of GuildRosterUnlinked	yes

GuildRosterCharacter

Field	Type	Required	Description
name	string	yes
class	WowClass | null	no
level	integer	yes
zone	string	yes
last_seen_at	string (date-time)	yes
is_main	boolean	yes

GuildRosterMember

Field	Type	Required	Description
member_id	integer	yes
name	string	yes
rank	string | null	yes
raid_status	string | null	yes
main	string | null	yes
characters	array of GuildRosterCharacter	yes

GuildRosterUnlinked

Field	Type	Required	Description
name	string	yes
class	WowClass | null	no
level	integer	yes
rank	string	yes
last_seen_at	string (date-time)	yes

HeroLeaderboard

Field	Type	Required	Description
season_id	string	yes
season_name	string	yes
rows	array of HeroRow	yes

HeroProfile

Field	Type	Required	Description
member_id	integer	yes
discord_id	string	yes
display_name	string	yes
avatar_url	string | null	yes
wow_class	WowClass | null	yes
rank	integer | null	yes
chat_level	integer	yes
chat_xp	integer	yes
chat_xp_into_level	integer	yes
chat_xp_for_next_level	integer	yes
seasons	object	yes
all_time	HeroSeasonStats	yes
first_event_date	string (date) | null	yes
recent_events	array of HeroRecentEvent	yes
badges	array of EarnedBadge	yes

HeroRecentEvent

Field	Type	Required	Description
id	string (uuid)	yes
kind	EventKind	yes
title	string	yes
starts_at	string (date-time)	yes
ep	integer	yes

HeroRow

Field	Type	Required	Description
rank	integer | null	yes
member_id	integer	yes
discord_id	string	yes
display_name	string	yes
avatar_url	string | null	yes
wow_class	WowClass | null	yes
chat_level	integer	yes
ep	integer	yes
raids_attended	integer	yes
events_attended	integer	yes
badge_ids	array of string	yes

HeroSeasonStats

Field	Type	Required	Description
ep	integer	yes
raids_attended	integer	yes
events_attended	integer	yes
attendance_rate	number	yes

ImportAttendanceResult

Field	Type	Required	Description
event_id	string (uuid) | null	yes
marked	integer	no

ImportCounts

Field	Type	Required	Description
new	integer	no
updated	integer	no

LeaderboardEntry

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

LeaderboardPage

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

LedgerKind

Whether a ledger entry is an EP or GP change.

Type: string

LevelRoleSchema

Field	Type	Required	Description
level	integer	yes
role_id	integer	yes

LevelRoleUpsert

Field	Type	Required	Description
role_id	integer	yes

LogActor

Field	Type	Required	Description
display_name	string	yes
avatar_url	string | null	yes

LogEntry

Field	Type	Required	Description
id	string	yes
at	string (date-time)	yes
kind	string	yes
actor	LogActor | null	yes
summary	string	yes
detail	string | null	yes
member_id	integer | null	yes
event_id	string (uuid) | null	yes
case_number	integer | null	yes

LogPage

Field	Type	Required	Description
entries	array of LogEntry	yes
next_before	string (date-time) | null	yes

LootImportCounts

Field	Type	Required	Description
new	integer	no
updated	integer	no
voided	integer	no

LootResponse

How a character rolled on an item.

Type: string

McpTokenCreate

Field	Type	Required	Description
name	string	yes

McpTokenCreated

Field	Type	Required	Description
id	string (uuid)	yes
name	string	yes
token	string	yes

McpTokenList

Field	Type	Required	Description
tokens	array of McpTokenSummary	yes

McpTokenSummary

Field	Type	Required	Description
id	string (uuid)	yes
name	string	yes
created_at	string (date-time)	yes
last_used_at	string (date-time) | null	yes

Me

Field	Type	Required	Description
id	integer	yes
discord_id	string	yes
username	string	yes
display_name	string	yes
avatar_url	string | null	yes
is_guild_member	boolean	yes
is_officer	boolean	yes
is_gm	boolean	yes
battletag	string | null	yes
roster_confirmed	boolean	yes

MemberAttendanceRow

Field	Type	Required	Description
member_id	integer	yes
display_name	string	yes
avatar_url	string | null	yes
signed_up	integer	yes
came	integer	yes
no_shows	integer	yes
walk_ins	integer	yes
attendance_rate	number	yes
last_attended	string (date-time) | null	yes

MemberLevelSchema

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

MemberLink

Field	Type	Required	Description
discord_id	integer	yes
battlenet_linked	boolean	yes
roster_confirmed	boolean	no

MemberListing

Field	Type	Required	Description
id	integer	yes
username	string	yes
display_name	string	yes
avatar_url	string | null	yes
is_guild_member	boolean	yes
is_officer	boolean	yes
battletag	string | null	yes
roster_confirmed	boolean	yes
last_login_at	string (date-time) | null	yes

MemberNoteImportCounts

Field	Type	Required	Description
new	integer	no
updated	integer	no
voided	integer	no

MemberProfileIn

Field	Type	Required	Description
discord_id	integer	yes
username	string	yes
global_name	string | null	yes
guild_nick	string | null	yes
avatar_hash	string | null	yes
roles	array of integer	yes

MemberProfilesReplace

Field	Type	Required	Description
profiles	array of MemberProfileIn	yes
departed_ids	array of integer	yes

ModCaseCreate

Field	Type	Required	Description
action	CaseAction	yes
user_id	integer	yes
moderator_id	integer	yes
reason	string | null	no
duration_seconds	integer | null	no

ModCaseSchema

Field	Type	Required	Description
guild_id	integer	yes
case_number	integer	yes
action	CaseAction	yes
user_id	integer	yes
moderator_id	integer	yes
reason	string | null	yes
duration_seconds	integer | null	yes
created_at	string (date-time)	yes

ModCaseUpdate

Field	Type	Required	Description
reason	string | null	no

MyCharacterCreate

Field	Type	Required	Description
name	string	yes
realm	string | null	no
class	WowClass | null	no

NewsKind

What kind of guild news feed item this is.

Type: string

PendingAnnouncement

Field	Type	Required	Description
id	string (uuid)	yes
text	string	yes
author	string	yes
at	string (date-time)	yes

PendingAnnouncementsPage

Field	Type	Required	Description
items	array of PendingAnnouncement	yes

PendingBadgeAnnouncement

Field	Type	Required	Description
discord_id	integer	yes
badge_id	string	yes
name	string	yes
description	string	yes

ProfessionImportCounts

Field	Type	Required	Description
updated	integer	no

RaidStatus

EPGP roster status, settable by an officer (PUT /api/epgp/roster/{member_id}).

Type: string

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

RecruitChecklist

Field	Type	Required	Description
talked	boolean	no
gear_check	boolean	no
first_raid	boolean	no
vouched	boolean	no

RecruitImportCounts

Field	Type	Required	Description
new	integer	no
updated	integer	no

RecruitStatus

A recruiting candidate’s status in the vetting pipeline.

Type: string

RecruitVoteChoice

An officer’s vote on a recruit.

Type: string

Recruiting

Field	Type	Required	Description
roles	array of RecruitingRoleWant	yes
classes	array of RecruitingClassWant	yes
updated_at	string (date-time) | null	yes

RecruitingClassWant

Field	Type	Required	Description
class	WowClass	yes
priority	RecruitingPriority	no
note	string | null	no

RecruitingPriority

How urgently the guild wants this role or class filled.

Type: string

RecruitingRoleWant

Field	Type	Required	Description
role	SignupRole	yes
priority	RecruitingPriority	no
note	string | null	no

RecruitingUpdate

Field	Type	Required	Description
roles	array of RecruitingRoleWant	no
classes	array of RecruitingClassWant	no

RoleMenuCreate

Field	Type	Required	Description
channel_id	integer	yes
title	string	yes
description	string | null	no
max_roles	integer	no

RoleMenuOptionSchema

Field	Type	Required	Description
role_id	integer	yes
label	string	yes
emoji	string | null	yes
description	string | null	yes
position	integer	yes

RoleMenuOptionUpsert

Field	Type	Required	Description
label	string	yes
emoji	string | null	no
description	string | null	no
position	integer | null	no

RoleMenuSchema

Field	Type	Required	Description
id	string (uuid)	yes
guild_id	integer	yes
channel_id	integer	yes
message_id	integer | null	yes
title	string	yes
description	string | null	yes
max_roles	integer	yes
options	array of RoleMenuOptionSchema	yes

RoleMenuUpdate

Field	Type	Required	Description
channel_id	integer | null	no
message_id	integer | null	no
title	string | null	no
description	string | null	no
max_roles	integer | null	no

RoleResetCandidate

Field	Type	Required	Description
id	string (uuid)	yes
discord_id	integer	yes
requested_at	string (date-time)	yes

RoleTag

Field	Type	Required	Description
id	string	yes
name	string	yes
color	string | null	yes

RosterImportCounts

Field	Type	Required	Description
updated	integer	no

SeriesRef

Field	Type	Required	Description
id	string (uuid)	yes
weekdays	array of integer	yes
interval_weeks	integer	yes
start_time	string	yes
timezone	string	yes

SeriesRule

Field	Type	Required	Description
weekdays	array of integer	yes
interval_weeks	integer	yes
start_time	string	yes
timezone	string	yes
duration_minutes	integer | null	yes
starts_on	string (date)	yes
until	string (date) | null	yes

SetXPRequest

Field	Type	Required	Description
xp	integer	yes

Signup

Field	Type	Required	Description
id	string (uuid)	yes
member	SignupMember	yes
character	string | null	yes
class	WowClass | null	yes
role	SignupRole | null	yes
status	SignupStatus	yes
comment	string | null	yes
group	integer | null	yes
bench	boolean	yes
updated_at	string (date-time)	yes

SignupActivity

Field	Type	Required	Description
id	string (uuid)	yes
thread_id	integer	yes
display_name	string	yes
action	string	yes
detail	string | null	no
discord_id	integer | null	no	Member to @-mention; None for rows from before.
comment	string | null	no

SignupByDiscord

Field	Type	Required	Description
signup	Signup | null	yes
defaults	SignupDefaults | null	yes
kind	EventKind	yes

SignupDefaults

Field	Type	Required	Description
character	string | null	yes
class	WowClass | null	yes
role	SignupRole | null	yes

SignupImportCounts

Field	Type	Required	Description
applied	integer	no
skipped_older	integer	no
unlinked	integer	no

SignupMember

Field	Type	Required	Description
display_name	string	yes
avatar_url	string | null	yes

SignupNoticeAck

Field	Type	Required	Description
channel_id	integer	yes
message_id	integer	yes

SignupNoticeCandidate

Field	Type	Required	Description
member_id	integer	yes
discord_id	string	yes
display_name	string	yes
username	string	yes
avatar_hash	string | null	yes
battletag	string | null	yes
roster_confirmed	boolean	yes
created_at	string (date-time)	yes

SignupNoticeResolution

Field	Type	Required	Description
member_id	integer	yes
discord_id	string	yes
display_name	string	yes
channel_id	string	yes
message_id	string	yes
confirmed_by	string | null	yes

SignupNoticesPage

Field	Type	Required	Description
pending	array of SignupNoticeCandidate	yes
resolved	array of SignupNoticeResolution	yes

SignupRole

What role a signed-up character plays.

Type: string

SignupStatus

Whether a member is coming.

Type: string

SignupUpsert

Field	Type	Required	Description
character	string | null	no
class	WowClass | null	no
role	SignupRole | null	no
status	SignupStatus	yes
comment	string | null	no

VoiceChannelCount

Field	Type	Required	Description
name	string	yes
count	integer	yes

VoicePresenceEntry

Field	Type	Required	Description
discord_id	string	yes
minutes	integer	yes

VoicePresenceReport

Field	Type	Required	Description
event_id	string (uuid)	yes
entries	array of VoicePresenceEntry	no

WalkInCandidate

Field	Type	Required	Description
member_id	integer	yes
display_name	string	yes
avatar_url	string | null	yes

WalkInCreate

Field	Type	Required	Description
member_id	integer	yes
character	string | null	no
class	WowClass | null	no
role	SignupRole | null	no

WeeklyBoardEvent

Field	Type	Required	Description
id	string (uuid)	yes
kind	EventKind	yes
title	string	yes
starts_at	string (date-time)	yes
discord_thread_id	integer | null	yes

WowClass

Playable WoW classes.

Type: string

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