Skip to main content
Version: 0.37.107

APIApplication

https://discord.com/developers/docs/resources/application#application-object

Index

Properties

Properties

optionalapproximate_guild_count

approximate_guild_count?: number

Approximate count of guilds the application has been added to

optionalapproximate_user_install_count

approximate_user_install_count?: number

Approximate count of users that have installed the app

optionalbot

bot?: APIUser

Partial user object for the bot user associated with the application

bot_public

bot_public: boolean

When false only app owner can join the app’s bot to guilds

bot_require_code_grant

bot_require_code_grant: boolean

When true the app’s bot will only join upon completion of the full oauth2 code grant flow

optionalcover_image

cover_image?: string

If this application is a game sold on Discord, this field will be the hash of the image on store embeds

optionalcustom_install_url

custom_install_url?: string

The application’s default custom authorization link, if enabled

description

description: string

The description of the app

flags

flags: ApplicationFlags

The application’s public flags

See https://discord.com/developers/docs/resources/application#application-object-application-flags

optionalguild

guild?: APIPartialGuild

A partial object of the associated guild

optionalguild_id

guild_id?: string

If this application is a game sold on Discord, this field will be the guild to which it has been linked

icon

icon: null | string

The icon hash of the app

id

id: string

The id of the app

optionalinstall_params

install_params?: APIApplicationInstallParams

Settings for the application’s default in-app authorization link, if enabled

optionalintegration_types_config

integration_types_config?: APIApplicationIntegrationTypesConfigMap

Default scopes and permissions for each supported installation context. Value for each key is an integration type configuration object

optionalinteractions_endpoint_url

interactions_endpoint_url?: null | string

The interactions endpoint URL for the application

name

name: string

The name of the app

optionalowner

owner?: APIUser

Partial user object containing info on the owner of the application

See https://discord.com/developers/docs/resources/user#user-object

optionalprimary_sku_id

primary_sku_id?: string

If this application is a game sold on Discord, this field will be the id of the “Game SKU” that is created, if exists

optionalprivacy_policy_url

privacy_policy_url?: string

The url of the application’s privacy policy

optionalredirect_uris

redirect_uris?: string[]

Array of redirect URIs for the application

optionalrole_connections_verification_url

role_connections_verification_url?: null | string

The application’s role connection verification entry point, which when configured will render the app as a verification method in the guild role verification configuration

optionalrpc_origins

rpc_origins?: string[]

An array of rpc origin urls, if rpc is enabled

optionalslug

slug?: string

If this application is a game sold on Discord, this field will be the URL slug that links to the store page

summary

summary:

An empty string

@deprecated

This field will be removed in v11

@unstable

This field is no longer documented by Discord and will be removed in v11

optionaltags

tags?: [string, string?, string?, string?, string?]

Up to 5 tags of max 20 characters each describing the content and functionality of the application

team

team: null | APITeam

The team this application belongs to

See https://discord.com/developers/docs/topics/teams#data-models-team-object

optionalterms_of_service_url

terms_of_service_url?: string

The url of the application’s terms of service

verify_key

verify_key: string

The hexadecimal encoded key for verification in interactions and the GameSDK’s GetTicket function

See https://discord.com/developers/docs/game-sdk/applications#getticket