Skip to main content
GET
/
guilds
/
{guild_id}
/
onboarding
cURL
curl --request GET \
  --url https://discord.com/api/v10/guilds/{guild_id}/onboarding \
  --header 'Authorization: <api-key>'
{
  "guild_id": "<string>",
  "prompts": [
    {
      "id": "<string>",
      "title": "<string>",
      "options": [
        {
          "id": "<string>",
          "title": "<string>",
          "description": "<string>",
          "emoji": {
            "id": "<unknown>",
            "name": "<string>",
            "animated": true
          },
          "role_ids": [
            "<string>"
          ],
          "channel_ids": [
            "<string>"
          ]
        }
      ],
      "single_select": true,
      "required": true,
      "in_onboarding": true,
      "type": 123
    }
  ],
  "default_channel_ids": [
    "<string>"
  ],
  "enabled": true
}

Authorizations

Authorization
string
header
required

Discord bot token

Path Parameters

guild_id
string<snowflake>
required

Response

200 response for get_guilds_onboarding

guild_id
string<snowflake>
required
prompts
object[]
required
default_channel_ids
string<snowflake>[]
required
enabled
boolean
required