Preview environment

interface APIExtendedInvite

extends

APIInvite
export interface APIExtendedInvite extends APIInvite

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

optional
approximate_member_count? : number

Approximate count of total members, returned from the GET /invites/<code> endpoint when with_counts is true

Inherited from: APIInvite

optional
approximate_presence_count? : number

Approximate count of online members, returned from the GET /invites/<code> endpoint when with_counts is true

Inherited from: APIInvite

channel : Required<APIPartialChannel> | null

The channel this invite is for

Inherited from: APIInvite

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

code : string

The invite code (unique ID)

Inherited from: APIInvite

created_at : string

When this invite was created

optional
expires_at? : string | null

The expiration date of this invite, returned from the GET /invites/<code> endpoint when with_expiration is true

Inherited from: APIInvite

optional
guild_scheduled_event? : APIGuildScheduledEvent

The guild scheduled event data, returned from the GET /invites/<code> endpoint when guild_scheduled_event_id is a valid guild scheduled event id

Inherited from: APIInvite

optional
guild? : APIInviteGuild

The guild this invite is for

Inherited from: APIInvite

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

optional
inviter? : APIUser

The user who created the invite

Inherited from: APIInvite

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

max_age : number

Duration (in seconds) after which the invite expires

max_uses : number

Max number of times this invite can be used

deprecatedoptional
stage_instance? : APIInviteStageInstance

The stage instance data if there is a public stage instance in the stage channel this invite is for

Inherited from: APIInvite

optional
target_application? : Partial<APIApplication>

The embedded application to open for this voice channel embedded application invite

Inherited from: APIInvite

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

optional
target_type? : InviteTargetType

The type of target for this voice channel invite

Inherited from: APIInvite

See also: https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types

optional
target_user? : APIUser

The user whose stream to display for this voice channel stream invite

Inherited from: APIInvite

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

temporary : boolean

Whether this invite only grants temporary membership

type : InviteType

The invite type

Inherited from: APIInvite

uses : number

Number of times this invite has been used