Skip to main content
Applications (or “apps”) are containers for developer platform features, and can be installed to Discord servers and/or user accounts.

​
Application Object

Application Structure
FieldTypeDescription
idsnowflakeID of the app
namestringName of the app
icon?stringIcon hash of the app
descriptionstringDescription of the app
rpc_origins?array of stringsList of RPC origin URLs, if RPC is enabled
bot_publicbooleanWhen false, only the app owner can add the app to guilds
bot_require_code_grantbooleanWhen true, the app’s bot will only join upon completion of the full OAuth2 code grant flow
bot?partial user objectPartial user object for the bot user associated with the app
terms_of_service_url?stringURL of the app’s Terms of Service
privacy_policy_url?stringURL of the app’s Privacy Policy
owner?partial user objectPartial user object for the owner of the app
verify_keystringHex encoded key for verification in interactions and the GameSDK’s GetTicket
team?team objectIf the app belongs to a team, this will be a list of the members of that team
guild_id?snowflakeGuild associated with the app. For example, a developer support server.
guild?partial guild objectPartial object of the associated guild
primary_sku_id?snowflakeIf this app is a game sold on Discord, this field will be the id of the “Game SKU” that is created, if exists
slug?stringIf this app is a game sold on Discord, this field will be the URL slug that links to the store page
cover_image?stringApp’s default rich presence invite cover image hash
flags?integerApp’s public flags
approximate_guild_count?integerApproximate count of guilds the app has been added to
approximate_user_install_count?integerApproximate count of users that have installed the app (authorized with application.commands as a scope)
approximate_user_authorization_count?integerApproximate count of users that have OAuth2 authorizations for the app
redirect_uris?array of stringsArray of redirect URIs for the app
interactions_endpoint_url??stringInteractions endpoint URL for the app
role_connections_verification_url??stringRole connection verification URL for the app
event_webhooks_url??stringEvent webhooks URL for the app to receive webhook events
event_webhooks_statusapplication event webhook statusIf webhook events are enabled for the app. 1 (default) means disabled, 2 means enabled, and 3 means disabled by Discord
event_webhooks_types?array of stringsList of Webhook event types the app subscribes to
tags?array of stringsList of tags describing the content and functionality of the app. Max of 5 tags.
install_params?install params objectSettings for the app’s default in-app authorization link, if enabled
integration_types_config?dictionary with keys of application integration typesDefault scopes and permissions for each supported installation context. Value for each key is an integration type configuration object
custom_install_url?stringDefault custom authorization URL for the app, if enabled
Example Application Object
{
  "bot_public": true,
  "bot_require_code_grant": false,
  "cover_image": "31deabb7e45b6c8ecfef77d2f99c81a5",
  "description": "Test",
  "guild_id": "290926798626357260",
  "icon": null,
  "id": "172150183260323840",
  "integration_types_config": {
    "0": {
      "oauth2_install_params": {
        "scopes": [
          "applications.commands",
          "bot"
        ],
        "permissions": "2048"
      }
    },
    "1": {
      "oauth2_install_params": {
        "scopes": [
          "applications.commands"
        ],
        "permissions": "0"
      }
    }
  },
  "name": "Baba O-Riley",
  "interactions_endpoint_url": null,
  "role_connections_verification_url": null,
  "event_webhooks_url": null,
  "event_webhooks_status": 1,
  "owner": {
    "avatar": null,
    "discriminator": "1738",
    "flags": 1024,
    "id": "172150183260323840",
    "username": "i own a bot"
  },
  "primary_sku_id": "172150183260323840",
  "slug": "test",
  "team": {
    "icon": "dd9b7dcfdf5351b9c3de0fe167bacbe1",
    "id": "531992624043786253",
    "members": [
      {
        "membership_state": 2,
        "permissions": ["*"],
        "team_id": "531992624043786253",
        "user": {
          "avatar": "d9e261cd35999608eb7e3de1fae3688b",
          "discriminator": "0001",
          "id": "511972282709709995",
          "username": "Mr Owner"
        }
      }
    ]
  },
  "verify_key": "1e0a356058d627ca38a5c8c9648818061d49e49bd9da9e3ab17d98ad4d6bg2u8"
}
Application Integration Types
Where an app can be installed, also called its supported installation contexts.
TypeIDDescription
GUILD_INSTALL0App is installable to servers
USER_INSTALL1App is installable to users
Application Integration Type Configuration Object
FieldTypeDescription
oauth2_install_params?install params objectInstall params for each installation context’s default in-app authorization link
Application Event Webhook Status
Status indicating whether event webhooks are enabled or disabled for an application.
NameValueDescription
DISABLED1Webhook events are disabled by developer
ENABLED2Webhook events are enabled by developer
DISABLED_BY_DISCORD3Webhook events are disabled by Discord, usually due to inactivity
Application Flags
ValueNameDescription
1 << 6APPLICATION_AUTO_MODERATION_RULE_CREATE_BADGEIndicates if an app uses the Auto Moderation API
1 << 12GATEWAY_PRESENCEIntent required for bots in 100 or more servers to receive presence_update events
1 << 13GATEWAY_PRESENCE_LIMITEDIntent required for bots in under 100 servers to receive presence_update events, found on the Bot page in your app’s settings
1 << 14GATEWAY_GUILD_MEMBERSIntent required for bots in 100 or more servers to receive member-related events like guild_member_add. See the list of member-related events under GUILD_MEMBERS
1 << 15GATEWAY_GUILD_MEMBERS_LIMITEDIntent required for bots in under 100 servers to receive member-related events like guild_member_add, found on the Bot page in your app’s settings. See the list of member-related events under GUILD_MEMBERS
1 << 16VERIFICATION_PENDING_GUILD_LIMITIndicates unusual growth of an app that prevents verification
1 << 17EMBEDDEDIndicates if an app is embedded within the Discord client (currently unavailable publicly)
1 << 18GATEWAY_MESSAGE_CONTENTIntent required for bots in 100 or more servers to receive message content
1 << 19GATEWAY_MESSAGE_CONTENT_LIMITEDIntent required for bots in under 100 servers to receive message content, found on the Bot page in your app’s settings
1 << 23APPLICATION_COMMAND_BADGEIndicates if an app has registered global application commands

​
Install Params Object

Install Params Structure
FieldTypeDescription
scopesarray of stringsScopes to add the application to the server with
permissionsstringPermissions to request for the bot role

​
Installation Context

An app’s installation context defines how it’s installed: to a server, to a user, or both. The installation context affects how your app can be seen and used within Discord. For example, apps installed only to a user can’t take actions in a server, and apps installed only to a server can’t be accessed within a user’s DMs.

​
Server Context

Apps installed in a server context (server-installed apps) must be authorized by a server member with the MANAGE_GUILD permission. Server-installed apps are visible to all members of the server, but other factors (like command permissions) determine where and when specific members can interact with the app. During installation, server-installed apps are authorized with a specific set of OAuth2 scopes and bot user permissions that determine what resources and data the app can access in that server.

​
User Context

Apps installed in a user context (user-installed apps) are visible only to the authorizing user, and therefore don’t require any server-specific permissions. Apps that support the user installation context are visible across all of an authorizing user’s servers, DMs, and GDMs, but are forced to respect the user’s permissions in the surface where the app is being used. For example, if a user invokes a command for a user-installed app from a server’s channel where they don’t have permission to send messages, the app won’t be able to respond to an interaction with a non-ephemeral message. Details about how the installation context of a command affects interactions is in the interaction context documentation.

​
Setting Supported Installation Contexts

By default, newly-created apps only support installation to guilds. You can update which installation contexts your app supports in your app’s settings. On the Installation page under the Installation Contexts section, you can select the installation contexts your app supports.
If you update your app to support a new installation context, you will need to update your existing commands if you want them to be supported in the new context. Details are in the Application Command documentation.
Install links provide an easy way for users to install your app in Discord. If you have an install link configured, an “Add App” button will appear in your app’s profile and App Directory page which will guide the user through your app’s installation flow. There are three options when configuring an install link for your app: “Discord Provided Link”, “Custom URL”, and “None”. If you don’t configure an install link (by selecting “None”), the “Add App” button will not appear for your app, and your app will not be eligible for the App Directory.
Note that install links are distinct from OAuth2 flows like the authorization code grant, which may additionally be required if you need to request user-specific scopes like identify or role_connections.write.
The default Discord Provided Link is a short link that guides users through the installation flow with your app’s configured installation contexts. If your app has both User Install and Guild Install enabled, the user can choose which way to install your app. Discord Provided Links don’t have scopes or bot user permissions defined in the URL. For example: 
https://discord.com/oauth2/authorize?client_id=1234567895647001626
Instead, these links will prompt the user for the scopes and bot user permissions configured in your Default Install Settings.
Discord Provided Links are limited to the application.commands and bot scopes

​
Custom URL

A Custom URL is an alternative to the Discord Provided Link that gives you more control of where users are directed when they click “Add App” on your app’s profile or App Directory page. A Custom URL doesn’t have strict limitations, but is commonly an OAuth2 /authorize URL that has defined scopes, permissions, and an installation context (integration_type). You can configure your app’s install link in your app’s settings. On the Installation page, go to the Install Link section, and select which type of install link you want for your app. For most apps, we recommend the Discord Provided Link. The Default Install Settings will appear on the Installation page when you have “Discord Provided Link” selected as your install link type.

​
Get Current Application

GET/applications/@me
Returns the application object associated with the requesting bot user.

​
Edit Current Application

PATCH/applications/@me
Edit properties of the app associated with the requesting bot user. Only properties that are passed will be updated. Returns the updated application object on success.
All parameters to this endpoint are optional
JSON Params
FieldTypeDescription
custom_install_urlstringDefault custom authorization URL for the app, if enabled
descriptionstringDescription of the app
role_connections_verification_urlstringRole connection verification URL for the app
install_paramsinstall params objectSettings for the app’s default in-app authorization link, if enabled
integration_types_configdictionary with keys of application integration typesDefault scopes and permissions for each supported installation context. Value for each key is an integration type configuration object
flags *integerApp’s public flags
icon?image dataIcon for the app
cover_image?image dataDefault rich presence invite cover image for the app
interactions_endpoint_url **stringInteractions endpoint URL for the app
tagsarray of stringsList of tags describing the content and functionality of the app (max of 20 characters per tag). Max of 5 tags.
event_webhooks_urlstringEvent webhooks URL for the app to receive webhook events
event_webhooks_statusapplication event webhook statusIf webhook events are enabled for the app. 1 to disable, and 2 to enable
event_webhooks_typesarray of stringsList of Webhook event types to subscribe to
* Only limited intent flags (GATEWAY_PRESENCE_LIMITED, GATEWAY_GUILD_MEMBERS_LIMITED, and GATEWAY_MESSAGE_CONTENT_LIMITED) can be updated via the API. ** To update an Interactions endpoint URL via the API, the URL must be valid according to the Receiving an Interaction documentation.

​
Get Application Activity Instance

GET/applications/{application.id}/activity-instances/{instance_id}
Returns a serialized activity instance, if it exists. Useful for preventing unwanted activity sessions.
Example Activity Instance
{
  "application_id": "1215413995645968394",
  "instance_id": "i-1276580072400224306-gc-912952092627435520-912954213460484116",
  "launch_id": "1276580072400224306",
  "location": {
    "id": "gc-912952092627435520-912954213460484116",
    "kind": "gc",
    "channel_id": "912954213460484116",
    "guild_id": "912952092627435520"
  },
  "users": ["205519959982473217"],
}
Activity Instance Object
FieldTypeDescription
application_idsnowflakeApplication ID
instance_idstringActivity Instance ID
launch_idsnowflakeUnique identifier for the launch
locationActivity LocationLocation the instance is running in
usersarray of snowflakes, user IDsIDs of the Users currently connected to the instance
Activity Location Object
The Activity Location is an object that describes the location in which an activity instance is running.
FieldTypeDescription
idstringUnique identifier for the location
kindActivity Location Kind EnumEnum describing kind of location
channel_idsnowflakeID of the Channel
guild_id??snowflakeID of the Guild
Activity Location Kind Enum
EnumDescription
’gc’Location is a Guild Channel
’pc’Location is a Private Channel, such as a DM or GDM