guild_get_welcome_screen
guild_get_welcome_screen
Section titled “guild_get_welcome_screen”Category: guild
Fetch the configured Community welcome screen.
When to use
Section titled “When to use”- Inspect onboarding before tweaking it.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to query |
Returns
Section titled “Returns”\{description, welcome_channels:[\{channel_id, description, emoji_id, emoji_name\}], untrusted_text\}. description and welcome_channels.description are wrapped untrusted (server-owner authored).
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
description | unknown | yes | |
welcome_channels | array | yes | |
untrusted_text | string | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |