onboarding_get
onboarding_get
Section titled “onboarding_get”Category: onboarding
Fetch a guild’s onboarding configuration.
When to use
Section titled “When to use”When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild whose onboarding config to fetch |
Returns
Section titled “Returns”\{guild_id, prompts, default_channel_ids, enabled, mode, untrusted_text\}. Prompt titles + option titles/descriptions wrapped untrusted.
See: https://discord.com/developers/docs/resources/guild#guild-onboarding-object
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Discord guild (server) ID |
prompts | array | yes | |
default_channel_ids | array | yes | |
enabled | boolean | yes | |
mode | integer | yes | |
untrusted_text | string | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |