Interface APIApplication

See

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

interface APIApplication {
    approximate_guild_count?: number;
    approximate_user_authorization_count?: number;
    approximate_user_install_count?: number;
    bot?: APIUser;
    bot_public: boolean;
    bot_require_code_grant: boolean;
    cover_image?: string;
    custom_install_url?: string;
    description: string;
    event_webhooks_status: ApplicationWebhookEventStatus;
    event_webhooks_types?: ApplicationWebhookEventType[];
    event_webhooks_url?: null | string;
    flags: ApplicationFlags;
    guild?: APIPartialGuild;
    guild_id?: string;
    icon: null | string;
    id: string;
    install_params?: APIApplicationInstallParams;
    integration_types_config?: APIApplicationIntegrationTypesConfigMap;
    interactions_endpoint_url?: null | string;
    name: string;
    owner?: APIUser;
    primary_sku_id?: string;
    privacy_policy_url?: string;
    redirect_uris?: string[];
    role_connections_verification_url?: null | string;
    rpc_origins?: string[];
    slug?: string;
    summary: "";
    tags?: [string, string?, string?, string?, string?];
    team: null | APITeam;
    terms_of_service_url?: string;
    verify_key: string;
}

Properties

approximate_guild_count? approximate_user_authorization_count? approximate_user_install_count? bot? bot_public bot_require_code_grant cover_image? custom_install_url? description event_webhooks_status event_webhooks_types? event_webhooks_url? flags guild? guild_id? icon id install_params? integration_types_config? interactions_endpoint_url? name owner? primary_sku_id? privacy_policy_url? redirect_uris? role_connections_verification_url? rpc_origins? slug? summary tags? team terms_of_service_url? verify_key

Properties

Optionalapproximate_guild_count

approximate_guild_count?: number

Approximate count of guilds the application has been added to

Optionalapproximate_user_authorization_count

approximate_user_authorization_count?: number

Approximate count of users that have OAuth2 authorizations for the app

Optionalapproximate_user_install_count

approximate_user_install_count?: number

Approximate count of users that have installed the app (authorized with application.commands as a scope)

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

event_webhooks_status

event_webhooks_status: ApplicationWebhookEventStatus

If webhook events are enabled for the app

Optionalevent_webhooks_types

event_webhooks_types?: ApplicationWebhookEventType[]

List of webhook event types the app subscribes to

Optionalevent_webhooks_url

event_webhooks_url?: null | string

Event webhook URL for the app to receive webhook events

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

Settings

Member Visibility

On This Page

Properties