guild_get_widget_settings
guild_get_widget_settings
Section titled “guild_get_widget_settings”Category: guild
Get widget settings for a guild (admin view).
When to use
Section titled “When to use”- Inspect whether the widget is enabled and to which invite channel it points.
When NOT to use
Section titled “When NOT to use”- Public widget data → use
guild_get_widget.
| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to query |
Returns
Section titled “Returns”\{enabled, channel_id\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes | |
channel_id | unknown | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |