Preview environment

interface APIApplication

export interface APIApplication

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

optional
approximate_guild_count? : number

Approximate count of guilds the application has been added to

optional
approximate_user_install_count? : number

Approximate count of users that have installed the app

bot_public : boolean

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

bot_require_code_grant : boolean

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

optional
bot? : APIUser

Partial user object for the bot user associated with the application

optional
cover_image? : string

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

optional
custom_install_url? : string

The application's default custom authorization link, if enabled

description : string

The description of the app

event_webhooks_status : ApplicationWebhookEventStatus

If webhook events are enabled for the app

optional
event_webhooks_types? : ApplicationWebhookEventType[]

List of webhook event types the app subscribes to

optional
event_webhooks_url? : string | null

Event webhook URL for the app to receive webhook events

flags : ApplicationFlags

The application's public flags

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

optional
guild_id? : Snowflake

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

optional
guild? : APIPartialGuild

A partial object of the associated guild

icon : string | null

The icon hash of the app

id : Snowflake

The id of the app

optional
install_params? : APIApplicationInstallParams

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

optional
integration_types_config? : APIApplicationIntegrationTypesConfigMap

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

optional
interactions_endpoint_url? : string | null

The interactions endpoint URL for the application

name : string

The name of the app

optional
owner? : APIUser

Partial user object containing info on the owner of the application

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

optional
primary_sku_id? : Snowflake

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

optional
privacy_policy_url? : string

The url of the application's privacy policy

optional
redirect_uris? : string[]

Array of redirect URIs for the application

optional
role_connections_verification_url? : string | null

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

optional
rpc_origins? : string[]

An array of rpc origin urls, if rpc is enabled

optional
slug? : string

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

deprecated
summary : ''

An empty string

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

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

team : APITeam | null

The team this application belongs to

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

optional
terms_of_service_url? : string

The url of the application's terms of service

verify_key : string

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

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