# Guild Hub

## `GET /api/guild/announcements`

**GetAnnouncements**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`GuildAnnouncementsPage <model-guildannouncementspage>`

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | array of {ref}`GuildAnnouncementRow <model-guildannouncementrow>` | yes |  |


## `POST /api/guild/announcements`

**CreateAnnouncement**

**Request body**

Model: {ref}`GuildAnnouncementCreate <model-guildannouncementcreate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `text` | string | yes |  |
| `discord` | boolean | no |  |

**Response `201` — Document created, URL follows**

Model: {ref}`GuildAnnouncementRow <model-guildannouncementrow>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `text` | string | yes |  |
| `author` | string | yes |  |
| `at` | string (date-time) | yes |  |
| `source` | {ref}`AnnouncementSource <model-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: {ref}`GuildBankPage <model-guildbankpage>`

| Field | Type | Required | Description |
|---|---|---|---|
| `rows` | array of {ref}`GuildBankRow <model-guildbankrow>` | yes |  |
| `totals` | {ref}`GuildBankTotals <model-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: {ref}`GuildCrafters <model-guildcrafters>`

| Field | Type | Required | Description |
|---|---|---|---|
| `results` | array of {ref}`GuildCrafterResult <model-guildcrafterresult>` | yes |  |
| `professions` | array of {ref}`GuildCrafterProfessionCount <model-guildcrafterprofessioncount>` | yes |  |


## `GET /api/guild/news`

**GetNews**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`GuildNewsPage <model-guildnewspage>`

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | array of {ref}`GuildNewsItem <model-guildnewsitem>` | yes |  |


## `GET /api/guild/roster`

**GetRoster**

**Response `200` — Request fulfilled, document follows**

Model: {ref}`GuildRoster <model-guildroster>`

| Field | Type | Required | Description |
|---|---|---|---|
| `taken_at` | string (date-time) \| null | yes |  |
| `members` | array of {ref}`GuildRosterMember <model-guildrostermember>` | yes |  |
| `unlinked` | array of {ref}`GuildRosterUnlinked <model-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: {ref}`PendingAnnouncementsPage <model-pendingannouncementspage>`

| Field | Type | Required | Description |
|---|---|---|---|
| `items` | array of {ref}`PendingAnnouncement <model-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: {ref}`AnnouncementPosted <model-announcementposted>`

| Field | Type | Required | Description |
|---|---|---|---|
| `message_id` | integer | yes |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`AnnouncementPostedResult <model-announcementpostedresult>`

| Field | Type | Required | Description |
|---|---|---|---|
| `message_id` | integer | yes |  |