> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Discord

> An instant messaging and VoIP social platform.

![Discord logo](https://mintcdn.com/composio-preview/VNLruGH5mLZqXdPH/images/toolkits/discord.svg?fit=max\&auto=format\&n=VNLruGH5mLZqXdPH\&q=85\&s=adeadbde1479ee4ce619a064ab67e515)

* **Category:** team chat
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** Yes
* **Tools:** 28
* **Triggers:** 1
* **Slug:** `DISCORD`
* **Version:** 20261101\_00

## Tools

> [accordion] Consume Entitlement (Deprecated)
>
> **Slug:** `DISCORD_CONSUME_ENTITLEMENT`
>
> Deprecated: Consumes an entitlement for an application. This endpoint requires a bot token and cannot be used by an OAuth2 user connection; the legacy action is retained for existing Discord bearer-token connections.
>
> #### Input Parameters
>
> **application\_id** `string` *required*
>
> The ID of the application that owns the entitlement.
>
> **entitlement\_id** `string` *required*
>
> The ID of the entitlement to mark as consumed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Test Entitlement (Deprecated)
>
> **Slug:** `DISCORD_DELETE_TEST_ENTITLEMENT`
>
> Deletes a test entitlement for a specified application. Deprecated: this endpoint requires a bot token and cannot be used by an OAuth2 user connection; the legacy action is retained for existing Discord bearer-token connections.
>
> #### Input Parameters
>
> **application\_id** `string` *required*
>
> The ID of the application that owns the test entitlement.
>
> **entitlement\_id** `string` *required*
>
> The ID of the test entitlement to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete User Application Role Connection
>
> **Slug:** `DISCORD_DELETE_USER_APPLICATION_ROLE_CONNECTION`
>
> Deletes the current user's application role connection for the specified application. Removes the platform metadata and linked role connection.
>
> #### Input Parameters
>
> **application\_id** `string` *required*
>
> The ID of the application to delete the role connection for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Edit Application Command Permissions
>
> **Slug:** `DISCORD_EDIT_APPLICATION_COMMAND_PERMISSIONS`
>
> Edits the permissions for a specific application command in a guild. Requires OAuth2 Bearer token (bot tokens will error). The authorizing user must have MANAGE\_GUILD and MANAGE\_ROLES permissions in the target guild.
>
> #### Input Parameters
>
> **guild\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the guild.
>
> **command\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the application command.
>
> **permissions** `array` *required*
>
> List of permission overrides to set for the command in the guild.
>
> **application\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the application.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Application Command Permissions
>
> **Slug:** `DISCORD_GET_APPLICATION_COMMAND_PERMISSIONS`
>
> Retrieves the permissions for a specific application command in a guild. Requires OAuth2 Bearer token (bot tokens will error). The authorizing user must have MANAGE\_GUILD and MANAGE\_ROLES permissions in the target guild.
>
> #### Input Parameters
>
> **guild\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the guild.
>
> **command\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the application command.
>
> **application\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the application.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Batch Application Command Permissions
>
> **Slug:** `DISCORD_GET_BATCH_APPLICATION_COMMAND_PERMISSIONS`
>
> Retrieves permissions for all commands of an application in a guild. Returns a list of permission objects for each command. Requires OAuth2 Bearer token (Bot tokens will error).
>
> #### Input Parameters
>
> **guild\_id** `string` *required*
>
> The ID of the guild.
>
> **application\_id** `string` *required*
>
> The ID of the application.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User Application Entitlements
>
> **Slug:** `DISCORD_GET_CURRENT_USER_APPLICATION_ENTITLEMENTS`
>
> Retrieves a page of entitlements for the current user and application, with optional SKU and guild filters and controls for ended or deleted entitlements. Supports before/after pagination; a guild-filtered page may contain fewer results than requested. Requires the applications.entitlements OAuth2 scope.
>
> #### Input Parameters
>
> **after** `string`
>
> Retrieve entitlements after this entitlement ID (snowflake). Used for forward pagination.
>
> **limit** `integer`
>
> Maximum number of entitlements to return (1-100, default 100).
>
> **before** `string`
>
> Retrieve entitlements before this entitlement ID (snowflake). Used for backward pagination.
>
> **sku\_ids** `array`
>
> Optional list of SKU IDs to filter entitlements by.
>
> **guild\_id** `string`
>
> Optional guild ID to filter entitlements by; only returns entitlements granted for that guild.
>
> **exclude\_ended** `boolean`
>
> Whether ended entitlements should be omitted. Defaults to false.
>
> **application\_id** `string` *required*
>
> The ID of the application to retrieve entitlements for.
>
> **exclude\_deleted** `boolean`
>
> Whether deleted entitlements should be omitted. Defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Gateway
>
> **Slug:** `DISCORD_GET_GATEWAY`
>
> Tool to retrieve a valid WebSocket (wss) URL for establishing a Gateway connection to Discord. Use when you need to connect to the Discord Gateway for real-time events.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Guild Template
>
> **Slug:** `DISCORD_GET_GUILD_TEMPLATE`
>
> Tool to retrieve information about a Discord guild template using its unique template code. Use when you need to get details about a guild template for creating new servers.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> The unique template code identifier for the guild template to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Guild Widget
>
> **Slug:** `DISCORD_GET_GUILD_WIDGET`
>
> Tool to retrieve the guild widget in JSON format. Use when you need to get public information about a Discord guild's widget that can be displayed on external websites. The widget must be enabled in the guild's server settings.
>
> #### Input Parameters
>
> **guild\_id** `string` *required*
>
> The unique identifier of the guild (snowflake ID).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Guild Widget PNG
>
> **Slug:** `DISCORD_GET_GUILD_WIDGET_PNG`
>
> Tool to retrieve a PNG image widget for a Discord guild. Use when you need a visual representation of the guild widget that can be displayed on external websites. The widget must be enabled in the guild's server settings.
>
> #### Input Parameters
>
> **style** `string ("shield" | "banner1" | "banner2" | "banner3" | "banner4")`
>
> Customizes the visual appearance of the widget image. Options: 'shield' (compact badge-style), 'banner1', 'banner2', 'banner3', 'banner4' (various horizontal banner formats).
>
> **guild\_id** `string` *required*
>
> The unique identifier of the guild (snowflake ID).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Invite (Deprecated)
>
> **Slug:** `DISCORD_GET_INVITE`
>
> Deprecated: Retrieves information about a specific Discord invite, including available guild or channel details. Do not infer guild membership or channel access from the response.
>
> #### Input Parameters
>
> **invite\_code** `string` *required*
>
> A single Discord invite code (e.g., "0vCdhLbwjZZTWZLD"). Can be provided as a bare code or as a full URL like "[https://discord.gg/0vCdhLbwjZZTWZLD](https://discord.gg/0vCdhLbwjZZTWZLD)". Only one invite code should be provided. If multiple codes or URLs are present, only the first one will be used.
>
> **with\_counts** `boolean`
>
> Whether to include approximate member and presence counts in the response (approximate\_member\_count and approximate\_presence\_count fields).
>
> **with\_expiration** `boolean`
>
> Whether to include the expiration date (expires\_at field) in the response. Note: expires\_at is typically returned regardless of this parameter.
>
> **guild\_scheduled\_event\_id** `string`
>
> The ID of a guild scheduled event to include with the invite. When provided, the response will include guild\_scheduled\_event details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get my guild member
>
> **Slug:** `DISCORD_GET_MY_GUILD_MEMBER`
>
> Retrieves the guild member object for the currently authenticated user within a specified guild, including roles, nickname, join date, and permissions.
>
> #### Input Parameters
>
> **guild\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the Discord guild (server) from which to fetch the member object.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get my OAuth2 authorization
>
> **Slug:** `DISCORD_GET_MY_OAUTH2_AUTHORIZATION`
>
> Retrieves current OAuth2 authorization details for the application, including app info, scopes, token expiration, and user data (contingent on scopes like 'identify').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get My User
>
> **Slug:** `DISCORD_GET_MY_USER`
>
> Fetches comprehensive profile information for the currently authenticated Discord user, including email if the 'email' scope is granted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get OpenID Connect userinfo
>
> **Slug:** `DISCORD_GET_OPENID_CONNECT_USERINFO`
>
> Retrieve OpenID Connect compliant user information for the authenticated user. Returns standardized OIDC user claims (sub, email, nickname, picture, locale, etc.) following the OpenID Connect specification. Requires OAuth2 access token with 'openid' scope; additional fields require 'identify' and 'email' scopes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Public Keys
>
> **Slug:** `DISCORD_GET_PUBLIC_KEYS`
>
> Tool to retrieve Discord OAuth2 public keys. Use when you need to verify OAuth2 tokens or access public keys for cryptographic operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SKU Subscription
>
> **Slug:** `DISCORD_GET_SKU_SUBSCRIPTION`
>
> Retrieves a specific subscription by ID for a given SKU. Use to check details of a single user subscription.
>
> #### Input Parameters
>
> **sku\_id** `string` *required*
>
> The ID of the SKU the subscription belongs to.
>
> **subscription\_id** `string` *required*
>
> The ID of the subscription to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User
>
> **Slug:** `DISCORD_GET_USER`
>
> Retrieve information about a Discord user. With OAuth Bearer token authentication, this returns the authenticated user's information (use '@me'). With Bot token authentication, you can query any user by their ID. Use this when you need user details like username, avatar, email (if email scope is granted), locale, premium status, or other profile information.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The ID of the user to retrieve. Use '@me' to get the current authenticated user. Note: With OAuth Bearer token authentication, only '@me' is supported. With Bot token authentication, you can query any user ID (snowflake format). If you're unsure, start with '@me'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Application Role Connection
>
> **Slug:** `DISCORD_GET_USER_APPLICATION_ROLE_CONNECTION`
>
> Retrieves the application role connection for the currently authenticated user for a specified application. Requires the role\_connections.write OAuth2 scope.
>
> #### Input Parameters
>
> **application\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the application to get the role connection for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resolve Invite
>
> **Slug:** `DISCORD_INVITE_RESOLVE`
>
> Tool to resolve and retrieve information about a Discord invite code. Use when you need to get details about a guild, channel, or event associated with an invite code.
>
> #### Input Parameters
>
> **code** `string` *required*
>
> The invite code to resolve (e.g., "discord-api" for vanity URLs, "abc123xyz" for regular invite codes, or a full URL like "[https://discord.gg/abc123xyz](https://discord.gg/abc123xyz)").
>
> **with\_counts** `boolean`
>
> Whether to include approximate member counts (approximate\_member\_count and approximate\_presence\_count) in the response.
>
> **with\_expiration** `boolean`
>
> Whether to include the expiration date (expires\_at) in the response. Note: This parameter is deprecated as expires\_at is now always returned.
>
> **guild\_scheduled\_event\_id** `string`
>
> The guild scheduled event ID to include with the invite. When provided with a valid event ID, returns guild\_scheduled\_event data in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Leave Guild (Deprecated)
>
> **Slug:** `DISCORD_LEAVE_GUILD`
>
> Deprecated: Leaves the specified Discord guild for the authenticated account. This endpoint requires a bot token; use DISCORDBOT\_LEAVE\_GUILD with a DiscordBot connection.
>
> #### Input Parameters
>
> **guild\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the guild to leave.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List My Connections
>
> **Slug:** `DISCORD_LIST_MY_CONNECTIONS`
>
> Retrieves a list of the authenticated user's connected third-party accounts on Discord.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List My Guilds
>
> **Slug:** `DISCORD_LIST_MY_GUILDS`
>
> Lists the current user's guilds, returning partial data for each; primarily used for displaying server lists or verifying memberships.
>
> #### Input Parameters
>
> **after** `string`
>
> Get guilds after this guild ID.
>
> **limit** `integer`
>
> Max number of guilds to return (1-200, default 200).
>
> **before** `string`
>
> Get guilds before this guild ID.
>
> **with\_counts** `boolean`
>
> Include approximate member and presence counts for each guild.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List SKU Subscriptions
>
> **Slug:** `DISCORD_LIST_SKU_SUBSCRIPTIONS`
>
> Lists all subscriptions for a given SKU. When using a Bot token, the user\_id query parameter is required. Returns paginated subscription objects.
>
> #### Input Parameters
>
> **after** `string`
>
> Retrieve subscriptions after this subscription ID for forward pagination.
>
> **limit** `integer`
>
> Maximum number of subscriptions to return (1-100, default 100).
>
> **before** `string`
>
> Retrieve subscriptions before this subscription ID for backward pagination.
>
> **sku\_id** `string` *required*
>
> The ID of the SKU to list subscriptions for.
>
> **user\_id** `string`
>
> The user ID to filter subscriptions for. Required when using a Bot token; not needed for OAuth2.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sticker Packs
>
> **Slug:** `DISCORD_LIST_STICKER_PACKS`
>
> Tool to retrieve all available Discord Nitro sticker packs. Use when you need to list or browse official Discord sticker packs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Modify Current User (Deprecated)
>
> **Slug:** `DISCORD_MODIFY_CURRENT_USER`
>
> Deprecated: Updates the authenticated Discord user's username or avatar, including removing the avatar. This endpoint requires a bot token; use DISCORDBOT\_UPDATE\_MY\_USER with a DiscordBot connection.
>
> #### Input Parameters
>
> **avatar** `string`
>
> New avatar as a base64-encoded image data URI (e.g., 'data:image/png;base64,...').
>
> **username** `string`
>
> New username for the user. Limited to 2 changes per hour by Discord.
>
> **remove\_avatar** `boolean`
>
> Set to true to remove the user's avatar (sends null to Discord API). Cannot be used together with avatar.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User Application Role Connection
>
> **Slug:** `DISCORD_UPDATE_USER_APPLICATION_ROLE_CONNECTION`
>
> Updates the application role connection for the currently authenticated user for a specified application. Requires the role\_connections.write OAuth2 scope.
>
> #### Input Parameters
>
> **metadata** `object`
>
> Object mapping application role connection metadata keys to their string-ified values.
>
> **platform\_name** `string`
>
> The vanity name of the platform a bot has connected (max 50 characters).
>
> **application\_id** `string` *required*
>
> The unique identifier (snowflake ID) of the application to update the role connection for.
>
> **platform\_username** `string`
>
> The username on the platform a bot has connected (max 100 characters).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

## Triggers

> [accordion] New Discord Message Trigger
>
> **Slug:** `DISCORD_NEW_MESSAGE_TRIGGER`
>
> **Type:** poll
>
> Polls a specific Discord channel for new messages.
>
> #### Configuration
>
> **channel\_id** `string` *required*
>
> The ID of the Discord channel to monitor for new messages.
>
> **interval** `number`
>
> Periodic Interval to Check for Updates & Send a Trigger in Minutes
>
> **limit** `integer`
>
> The number of messages to fetch per poll.
>
> #### Payload
>
> **event\_type** `string`
>
> Type of Discord message event
>
> **message** `object` *required*
>
> The Discord message that was created
