Application Resource

Applications are Discord entities that represent games, services, and other integrations that can be added to a guild. Applications can be used for a variety of purposes, including OAuth2 authentication, rich presence, bots, and much more.

Application Object

Application Structure

¹ The primary_sku_id and slug fields can be combined to form a URL to the application's primary store page like so: https://discord.com/store/skus/{primary_sku_id}/{slug}.

² Only present when fetched from the Get Current Application, Get Application, or Transfer Application endpoints.

³ In some cases, these fields may still be provided instead of integration_public and integration_require_code_grant. These fields will not be present if the application does not have a bot.

⁴ The sending of Gateway events over the interactions endpoint requires interactions version 2.

⁵ Only applicable for applications of type CREATOR_MONETIZATION.

⁶ Only applicable for applications with the EMBEDDED flag.

Partial Application Structure

¹ The primary_sku_id and slug fields can be combined to form a URL to the application's primary store page like so: https://discord.com/store/skus/{primary_sku_id}/{slug}.

² Only present when fetched from the Get Guild Applications endpoint. You must own the application or be a member of the owning team to receive this information.

³ In some cases, these fields may still be provided instead of integration_public and integration_require_code_grant. These fields will not be present if the application does not have a bot.

⁴ Only applicable for applications with the EMBEDDED flag.

Application Type

¹ Applications of these types cannot be used through most of the regular applications APIs outlined here.

Application Flags

Application Interactions Version

Explicit Content Filter Level

Application Verification State

Store Application State

RPC Application State

Application Discoverability State

Application Discovery Eligibility Flags

Application Monetization State

Application Monetization Eligibility Flags

Example Application

{
  "id": "891436243903728565",
  "name": "Socket",
  "icon": "26f3dcdc6e6371b52c384c812c30546c",
  "description": "Socket",
  "type": null,
  "bot": {
    "id": "891436243903728565",
    "username": "Socket",
    "avatar": "26f3dcdc6e6371b52c384c812c30546c",
    "discriminator": "0001",
    "public_flags": 0,
    "bot": true,
    "banner": null,
    "accent_color": null,
    "global_name": null,
    "avatar_decoration_data": null
  },
  "deeplink_uri": "https://google.com/search?q=power+sockets+near+me",
  "bot_public": true,
  "bot_require_code_grant": false,
  "verify_key": "852634a9ed80c0c5ac81e3c46d4b10a05400cb71898ea0484e7b63ac3a27096a",
  "flags": 27828224,
  "tags": ["60hz", "AC", "", "120v"],
  "hook": true,
  "redirect_uris": ["http://localhost:5000/callback"],
  "interactions_endpoint_url": null,
  "role_connections_verification_url": "https://google.com/search?q=power+sockets+near+me",
  "owner": {
    "id": "1110738998453837384",
    "username": "team1110738998453837384",
    "avatar": null,
    "discriminator": "0000",
    "public_flags": 1024,
    "banner": null,
    "accent_color": null,
    "global_name": null,
    "avatar_decoration_data": null
  },
  "approximate_guild_count": 100,
  "approximate_user_install_count": 1000,
  "interactions_event_types": [],
  "interactions_version": 1,
  "explicit_content_filter": 1,
  "rpc_application_state": 0,
  "store_application_state": 1,
  "creator_monetization_state": 1,
  "verification_state": 1,
  "integration_public": true,
  "integration_require_code_grant": false,
  "discoverability_state": 1,
  "discovery_eligibility_flags": 36294,
  "monetization_state": 1,
  "monetization_eligibility_flags": 0,
  "is_monetized": false,
  "publishers": [{ "id": "1058932127820939295", "name": "AlienTec" }],
  "developers": [{ "id": "1058932084854509568", "name": "Alien Games" }],
  "team": {
    "id": "1110738998453837384",
    "icon": null,
    "name": "Power",
    "owner_user_id": "852892297661906993",
    "members": [
      {
        "user": {
          "id": "852892297661906993",
          "username": "dolfies",
          "avatar": "c78ef8fb1db15a3d5f1b4c057856c5c9",
          "discriminator": "0",
          "public_flags": 136,
          "banner": null,
          "accent_color": null,
          "global_name": "Dolfies",
          "avatar_decoration_data": null,
          "clan": null
        },
        "team_id": "1110738998453837384",
        "membership_state": 2,
        "role": "admin"
      }
    ]
  },
  "internal_guild_restriction": 1
}

Example Partial Application

{
  "id": "880218394199220334",
  "name": "Watch Together",
  "icon": "ec48acbad4c32efab4275cb9f3ca3a58",
  "description": "Create and watch a playlist of YouTube videos with your friends. Your choice to share the remote or not. ",
  "type": null,
  "cover_image": "3cc9446876ae9eec6e06ff565703c292",
  "bot": {
    "id": "880218394199220334",
    "username": "Watch Together",
    "avatar": "fe2b7fa334817b0346d57416ad75e93b",
    "discriminator": "5319",
    "public_flags": 0,
    "bot": true,
    "banner": null,
    "accent_color": null,
    "global_name": null,
    "avatar_decoration_data": null
  },
  "summary": "",
  "bot_public": false,
  "bot_require_code_grant": false,
  "terms_of_service_url": "https://discord.com/terms",
  "privacy_policy_url": "https://discord.com/privacy",
  "verify_key": "e2aaf50fbe2fd9d025ac669035f5efb89099931690fba9dc28efb7eaade7f96d",
  "flags": 1179648,
  "max_participants": -1,
  "tags": ["Video Player", "Watch"],
  "hook": true,
  "is_monetized": false,
  "embedded_activity_config": {
    "activity_preview_video_asset_id": "1104184163201990836",
    "supported_platforms": ["web", "ios", "android"],
    "default_orientation_lock_state": 2,
    "tablet_default_orientation_lock_state": 1,
    "requires_age_gate": false,
    "premium_tier_requirement": null,
    "free_period_starts_at": null,
    "free_period_ends_at": null,
    "client_platform_config": {
      "ios": { "label_type": 0, "label_until": null, "release_phase": "global_launch" },
      "android": { "label_type": 0, "label_until": null, "release_phase": "global_launch" },
      "web": { "label_type": 0, "label_until": null, "release_phase": "global_launch" }
    },
    "shelf_rank": 3,
    "has_csp_exception": false,
    "displays_advertisements": false
  }
}

Application Executable Object

Application Executable Structure

Example Application Executable

{
  "os": "win32",
  "name": "spaceship looter/spaceship_looter.exe",
  "is_launcher": false
}

Application SKU Object

Application SKU Structure

Distributor Type

Example Application SKU

{
  "id": "445220",
  "sku": "445220",
  "distributor": "steam"
}

Application Install Params Object

Application Install Params Structure

Application Integration Type

An application's supported installation contexts.

Application Integration Type Configuration Structure

Example Application Install Params

{
  "scopes": ["applications.commands", "bot"],
  "permissions": "8"
}

Application Proxy Config Object

The application proxy makes it possible to proxy requests to a domain through the Discord activity proxy. This is used by embedded activities to be able to make requests without being blocked by Discord's content security policy (CSP).

Mapped URLs are available at <application_id>.discordsays.com/.proxy/<prefix>.

Application Proxy Config Structure

Application Proxy Mapping Structure

Example Application Proxy Config

{
  "url_map": [
    {
      "prefix": "/api",
      "target": "api.example.com"
    }
  ]
}

Embedded Activity Config Object

Embedded Activity Config Structure

¹ Omitted in the application object.

Embedded Activity Orientation Lock State Type

Embedded Activity Platform Type

Embedded Activity Platform Config Structure

Embedded Activity Label Type

Embedded Activity Release Phase

Example Embedded Activity Config

{
  "activity_preview_video_asset_id": "1104184163201990836",
  "supported_platforms": ["web", "ios", "android"],
  "default_orientation_lock_state": 2,
  "tablet_default_orientation_lock_state": 1,
  "requires_age_gate": false,
  "premium_tier_requirement": null,
  "free_period_starts_at": null,
  "free_period_ends_at": null,
  "client_platform_config": {
    "android": { "label_type": 0, "label_until": null, "release_phase": "global_launch" },
    "ios": { "label_type": 0, "label_until": null, "release_phase": "global_launch" },
    "web": { "label_type": 0, "label_until": null, "release_phase": "global_launch" }
  },
  "shelf_rank": 3,
  "has_csp_exception": false,
  "displays_advertisements": false,
  "application_id": "880218394199220334"
}

Application Asset Object

Application Asset Structure

Application Asset Type

Example Application Asset

{
  "id": "1131721726514954381",
  "type": 1,
  "name": "alien"
}

Application Role Connection Object

The role connection object that an application has attached to a user.

Application Role Connection Structure

Application Role Connection Metadata Object

A representation of role connection metadata for an application.

When a guild has added an application integration and that integration has configured its role_connections_verification_url, the application will render as a potential verification method in the guild's role verification configuration.

If an application has configured role connection metadata, its metadata will appear in the role verification configuration when the application has been added as a verification method to the role.

When a user connects their account using the integration's role_connections_verification_url, the integration will update a user's role connection with metadata using the OAuth2 role_connections.write scope.

Application Role Connection Metadata Structure

Application Role Connection Metadata Type

Endpoints

Get Applications

Returns a list of application objects that the current user has.

Query String Params

Get Applications with Assets

Returns a list of application objects that the current user has, additionally including the application's assets.

Query String Params

Response Body

Example Response

{
  "applications": [
    {
      "id": "891436243903728565",
      "name": "Lightbulb",
      "icon": "546242649e3b09a97af7e8f29983837b",
      "description": "\ud83d\udca1 Let there be light",
      "summary": "",
      "type": null,
      "is_monetized": false,
      "cover_image": "75bc61df60fc74c46b32fde3532f662b",
      "deeplink_uri": "https://google.com/search?q=lightbulbs+near+me",
      "hook": true,
      "guild_id": "1029315212005888060",
      "storefront_available": false,
      "bot_public": true,
      "bot_require_code_grant": false,
      "terms_of_service_url": "https://google.com/search?q=lightbulbs+near+me",
      "privacy_policy_url": "https://google.com/search?q=lightbulbs+near+me",
      "integration_types_config": {
        "0": {},
        "1": {}
      },
      "verify_key": "852634a9ed80c0c5ac81e3c46d4b10a05400cb71898ea0484e7b63ac3a27096a",
      "owner": {
        "id": "1110738998453837384",
        "username": "team1110738998453837384",
        "global_name": null,
        "avatar": null,
        "avatar_decoration_data": null,
        "discriminator": "0000",
        "public_flags": 1024,
        "clan": null,
        "flags": 1024
      },
      "flags": 27959296,
      "redirect_uris": ["http://localhost:5000/callback"],
      "rpc_application_state": 0,
      "store_application_state": 1,
      "verification_state": 1,
      "interactions_endpoint_url": null,
      "interactions_event_types": [],
      "interactions_version": 1,
      "integration_public": true,
      "integration_require_code_grant": false,
      "explicit_content_filter": 1,
      "discoverability_state": 1,
      "discovery_eligibility_flags": 36830,
      "monetization_state": 1,
      "role_connections_verification_url": "https://google.com/search?q=lightbulbs+near+me",
      "internal_guild_restriction": 1,
      "bot": {
        "id": "891436243903728565",
        "username": "Lightbulb",
        "global_name": null,
        "avatar": "546242649e3b09a97af7e8f29983837b",
        "avatar_decoration_data": null,
        "discriminator": "5312",
        "public_flags": 0,
        "clan": null,
        "bot": true
      },
      "approximate_guild_count": 100,
      "approximate_user_install_count": 1000,
      "max_participants": -1,
      "embedded_activity_config": {
        "activity_preview_video_asset_id": "1131721726514954381",
        "supported_platforms": ["web", "android", "ios"],
        "default_orientation_lock_state": 1,
        "tablet_default_orientation_lock_state": 1,
        "requires_age_gate": false,
        "premium_tier_requirement": null,
        "free_period_starts_at": null,
        "free_period_ends_at": null,
        "client_platform_config": {
          "web": {
            "label_type": 0,
            "label_until": null,
            "release_phase": "in_development"
          },
          "android": {
            "label_type": 0,
            "label_until": null,
            "release_phase": "in_development"
          },
          "ios": {
            "label_type": 0,
            "label_until": null,
            "release_phase": "in_development"
          }
        },
        "shelf_rank": 2147483647,
        "has_csp_exception": false,
        "displays_advertisements": false
      },
      "tags": ["", "100W", "EnergyStar", "LED"]
    }
  ],
  "assets": {
    "891436243903728565": [
      {
        "id": "1223782285833273507",
        "type": 1,
        "name": "embedded_background"
      },
      {
        "id": "1223782287091564634",
        "type": 1,
        "name": "embedded_cover"
      }
    ]
  }
}

Create Application

Creates a new application. Returns an application object on success. Users can have a maximum of 50 applications, with each team able to have a maximum of 25.

JSON Params

Get Application

Returns an application object for the given ID. User must be the owner of the application or member of the current team.

Get Current Application

Returns the application object associated with the requestor.

Modify Application

Modifies an application. User must be the owner of the application or developer of the current team. Returns the updated application object on success.

JSON Params

¹ The sending of Gateway events over the interactions endpoint requires interactions version 2.

Modify Current Application

Modifies the requestor's application information. Returns the updated application object on success.

JSON Params

Delete Application

Deletes an application permanently. User must be the owner of the application or current team. Returns a 204 empty response on success.

Transfer Application

Transfers ownership of an application to a team. User must be the owner of the application or current team. Returns an application object on success.

JSON Params

Reset Application Secret

Resets the application's client secret. This revokes all previous secrets and returns a new secret. User must be the owner of the application or developer of the current team.

Response Body

Example Response

{
  "secret": "937it3ow87i4ery69876wqire"
}

Create Application Bot

Creates and attaches a bot to the given application ID. User must be the owner of the application or developer of the current team.

Response Body

Example Response

{
  "token": "NzIyNDUwMzAzOTE5NTg3NDA5.GRj2Bt.cPbrvvjxglZXK4dTcIPDMvfq0LxJcilsIYW01A"
}

Modify Application Bot

Modifies the application's bot. User must be the owner of the application or developer of the current team. Returns the updated user object on success.

JSON Params

Reset Application Bot Token

Resets the application's bot token. This revokes all previous tokens and returns a new token. User must be the owner of the application or developer of the current team.

Response Body

Get Application Discoverability State

Returns information about the application's eligibility for application directory. User must be the owner of the application or member of the current team.

Response Body

Set Application Embeddability

Modifies whether the application is an embedded activity or not (determined by the EMBEDDED flag). User must be the owner of the application or developer of the current team. Returns a 204 empty response on success.

JSON Params

Get Application Embedded Activity Config

Returns the embedded activity config object for the given application ID. User must be the owner of the application or member of the current team.

Modify Application Embedded Activity Config

Modifies the embedded activity config for the given application ID. User must be the owner of the application or developer of the current team. Returns the updated embedded activity config object on success.

JSON Params

Get Application Proxy Config

Returns the application's activity proxy config object for the given application ID. User must be the owner of the application or member of the current team.

Modify Application Proxy Config

Replaces the activity proxy config for the given application ID. User must be the owner of the application or developer of the current team. Returns the updated application proxy config object on success.

Notes:

• URL mappings can utilize any protocol, so the protocol should be omitted from the target field.
• Parameter matching is supported in both the prefix and target fields. For example, you can map /server/{id} to server-{id}.example.com.
• Because of how URL globbing works, the order of the mappings is important. The most specific mappings should be at the top of the list as the first match is used. For example, if you have /foo and /foo/bar, you must place the URL /foo/bar before /foo or else the mapping for /foo/bar will never be reached.

JSON Params

Get Application Assets

Returns a list of application assets for the given application ID.

Create Application Asset

Creates a new application asset for the given application ID. User must be the owner of the application or developer of the current team. Returns an application asset object on success.

JSON Params

Delete Application Asset

Deletes an application asset permanently. User must be the owner of the application or developer of the current team. Returns a 204 empty response on success.

Create Application Attachment

Uploads an ephemeral attachment to the application. Must be a multipart/form-data body.

Form Params

Get Detectable Applications

Returns a list of partial application objects representing games that can be detected by Discord for rich presence.

Get Partial Applications

Returns a list of partial application objects for the given IDs.

Query String Params

Get Partial Application

Returns a partial application object for the given ID with all public application fields.

Get Rich Presence Application

Returns a partial application object for the given ID with rich presence-related fields.

Get Guild Applications

Returns a list of application objects attached to the given guild ID. Requires the MANAGE_GUILD permission.

Query String Params

¹ You must own the application or be a member of the owning team to receive this information.

Get User Application Role Connection

Returns an application role connection object for the user, without optional fields.

Modify User Application Role Connection

Updates an application's role connection for the user. Returns the updated application role connection object on success.

JSON Params