Discord.https - v3.0.16
    Preparing search index...

    Interface APIInvite

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

    interface APIInvite {
        approximate_member_count?: number;
        approximate_presence_count?: number;
        channel: null | APIInviteChannel;
        code: string;
        expires_at: null | string;
        flags?: IsGuestInvite;
        guild?: APIInviteGuild;
        guild_scheduled_event?: APIGuildScheduledEvent;
        inviter?: APIUser;
        stage_instance?: undefined;
        target_application?: Partial<APIApplication>;
        target_type?: InviteTargetType;
        target_user?: APIUser;
        type: InviteType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    approximate_member_count? approximate_presence_count? channel code expires_at flags? guild? guild_scheduled_event? inviter? stage_instance? target_application? target_type? target_user? type

    Properties

    approximate_member_count?: number

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

    approximate_presence_count?: number

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

    channel: null | APIInviteChannel

    The channel this invite is for

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

    code: string

    The invite code (unique ID)

    expires_at: null | string

    The expiration date of this invite

    flags?: IsGuestInvite

    The flags of the invite

    guild?: APIInviteGuild

    The guild this invite is for

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

    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

    inviter?: APIUser

    The user who created the invite

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

    stage_instance?: undefined

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

    This has been removed from the documentation. discord-api-docs#7779

    target_application?: Partial<APIApplication>

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

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

    target_type?: InviteTargetType

    The type of target for this voice channel invite

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

    target_user?: APIUser

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

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

    type: InviteType

    The invite type

    Settings

    Member Visibility

    On This Page

    Properties