Guild Hub

GET /api/guild/announcements

GetAnnouncements

Response 200 — Request fulfilled, document follows

Model: GuildAnnouncementsPage

Field	Type	Required	Description
items	array of GuildAnnouncementRow	yes

POST /api/guild/announcements

CreateAnnouncement

Request body

Model: GuildAnnouncementCreate

Field	Type	Required	Description
text	string	yes
discord	boolean	no

Response 201 — Document created, URL follows

Model: 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

GET /api/guild/bank

GetBank

Parameters

Name	In	Type	Required	Description
limit	query	integer	no
before	query	string (date-time) | null	no

Response 200 — Request fulfilled, document follows

Model: GuildBankPage

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

GET /api/guild/crafters

GetCrafters

Parameters

Name	In	Type	Required	Description
q	query	string | null	no
profession	query	string | null	no

Response 200 — Request fulfilled, document follows

Model: GuildCrafters

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

GET /api/guild/news

GetNews

Parameters

Name	In	Type	Required	Description
limit	query	integer	no

Response 200 — Request fulfilled, document follows

Model: GuildNewsPage

Field	Type	Required	Description
items	array of GuildNewsItem	yes

GET /api/guild/roster

GetRoster

Response 200 — Request fulfilled, document follows

Model: GuildRoster

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

GET /api/guilds/{guild_id}/announcements/pending

GetPending

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes

Response 200 — Request fulfilled, document follows

Model: PendingAnnouncementsPage

Field	Type	Required	Description
items	array of PendingAnnouncement	yes

POST /api/guilds/{guild_id}/announcements/{announcement_id}/posted

MarkPosted

Parameters

Name	In	Type	Required	Description
guild_id	path	integer	yes
announcement_id	path	string (uuid)	yes

Request body

Model: AnnouncementPosted

Field	Type	Required	Description
message_id	integer	yes

Response 200 — Request fulfilled, document follows

Model: AnnouncementPostedResult

Field	Type	Required	Description
message_id	integer	yes