specifications/API/models/Guild.md

25 lines
1.3 KiB
Markdown

## Guild Object
Represents a guild in an [[Instance]].
**Structure**
| Field | Type | Description |
| ------------ | ---------------------------------------------- | ------------------------------ |
| id | string | ID of the guild |
| description | string | Description of the guild |
| name | string | Name of the guild |
| icon | string | URL for the icon |
| owner_id | string | ID of the owner |
| roles | array of [[#Role Object\|Role]] objects | Roles in the guild |
| emojis | array of [[Emoji#Emoji Object\|Emoji]] objects | Emojis in the guild |
| member_count | integer | Number of members in the guild |
### Role Object
**Structure**
| Field | Type | Description |
| ----- | ------ | ----------------------- |
| id | string | ID of the role |
| name | string | Name of the role |
| icon | string | URL for the role's icon |