---
title: "GET /invites/{code}"
method: GET
path: "/invites/{code}"
---

# GET /invites/{code}

`GET /invites/{code}`

## Query parameters

- `with_counts` boolean
- `guild_scheduled_event_id` string, snowflake
- `target_channel_id` string, snowflake
- `target_message_id` string, snowflake

## Response `200`

200 response for invite_resolve

- union
  - FriendInviteResponse
    - `type` union, required
      - 0
      - 1
      - 2
    - `code` string, required
    - `inviter` UserResponse
      - `id` string, snowflake, required
      - `username` string, required — the user's username, not unique across the platform
      - `avatar` string, nullable, required — the user's avatar hash
      - `discriminator` string, required — the user's Discord-tag
      - `public_flags` integer, required — the public flags on a user's account
      - `flags` integer, required
      - `bot` boolean — whether the user belongs to an OAuth2 application
      - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system)
      - `banner` string, nullable — the user's banner hash
      - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code
      - `global_name` string, nullable, required — the user's display name, if it is set
      - `avatar_decoration_data` UserAvatarDecorationResponse
        - `asset` string, required — the avatar decoration hash
        - `sku_id` string, snowflake, required
      - `collectibles` UserCollectiblesResponse
        - `nameplate` UserNameplateResponse, required
          - `sku_id` string, snowflake, required
          - `asset` string, required — Path to the nameplate asset
          - `label` string, required — The label of this nameplate. Currently unused
          - `palette` union, required
            - 'crimson' — Crimson color palette
            - 'berry' — Berry color palette
            - 'sky' — Sky color palette
            - 'teal' — Teal color palette
            - 'forest' — Forest color palette
            - 'bubble_gum' — Bubble gum color palette
            - 'violet' — Violet color palette
            - 'cobalt' — Cobalt color palette
            - 'clover' — Clover color palette
            - 'lemon' — Lemon color palette
            - 'white' — White color palette
            - 'black' — Black color palette
      - `primary_guild` UserPrimaryGuildResponse, required
        - `identity_guild_id` string, snowflake, required
        - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag
        - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters
        - `badge` string, nullable, required — the server tag badge hash
    - `max_age` integer
    - `created_at` string, date-time
    - `expires_at` string, date-time, nullable, required
    - `friends_count` integer
    - `channel` InviteChannelResponse, required
      - `id` string, snowflake, required
      - `type` union, required
        - 1 — A direct message between users
        - 3 — A direct message between multiple users
        - 0 — A text channel within a server
        - 2 — A voice channel within a server
        - 4 — An organizational category that contains up to 50 channels
        - 5 — A channel that users can follow and crosspost into their own server (formerly news channels)
        - 10 — A temporary sub-channel within a GUILD_ANNOUNCEMENT channel
        - 11 — A temporary sub-channel within a GUILD_TEXT or GUILD_THREADS_ONLY channel type set
        - 12 — A temporary sub-channel within a GUILD_TEXT channel that is only viewable by those invited and those with the MANAGE_THREADS permission
        - 13 — A voice channel for hosting events with an audience
        - 14 — The channel in a hub containing the listed servers
        - 15 — Channel that can only contain threads
      - `name` string, nullable, required
      - `icon` string
      - `recipients` InviteChannelRecipientResponse[]
        - `id` string, snowflake, required
        - `username` string, required
        - `avatar` string, nullable, required
    - `is_contact` boolean
    - `uses` integer
    - `max_uses` integer
    - `flags` integer
  - GroupDMInviteResponse
    - `type` union, required
      - 0
      - 1
      - 2
    - `code` string, required
    - `inviter` UserResponse
      - `id` string, snowflake, required
      - `username` string, required — the user's username, not unique across the platform
      - `avatar` string, nullable, required — the user's avatar hash
      - `discriminator` string, required — the user's Discord-tag
      - `public_flags` integer, required — the public flags on a user's account
      - `flags` integer, required
      - `bot` boolean — whether the user belongs to an OAuth2 application
      - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system)
      - `banner` string, nullable — the user's banner hash
      - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code
      - `global_name` string, nullable, required — the user's display name, if it is set
      - `avatar_decoration_data` UserAvatarDecorationResponse
        - `asset` string, required — the avatar decoration hash
        - `sku_id` string, snowflake, required
      - `collectibles` UserCollectiblesResponse
        - `nameplate` UserNameplateResponse, required
          - `sku_id` string, snowflake, required
          - `asset` string, required — Path to the nameplate asset
          - `label` string, required — The label of this nameplate. Currently unused
          - `palette` union, required
            - 'crimson' — Crimson color palette
            - 'berry' — Berry color palette
            - 'sky' — Sky color palette
            - 'teal' — Teal color palette
            - 'forest' — Forest color palette
            - 'bubble_gum' — Bubble gum color palette
            - 'violet' — Violet color palette
            - 'cobalt' — Cobalt color palette
            - 'clover' — Clover color palette
            - 'lemon' — Lemon color palette
            - 'white' — White color palette
            - 'black' — Black color palette
      - `primary_guild` UserPrimaryGuildResponse, required
        - `identity_guild_id` string, snowflake, required
        - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag
        - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters
        - `badge` string, nullable, required — the server tag badge hash
    - `max_age` integer
    - `created_at` string, date-time
    - `expires_at` string, date-time, nullable, required
    - `channel` InviteChannelResponse, required
      - `id` string, snowflake, required
      - `type` union, required
        - 1 — A direct message between users
        - 3 — A direct message between multiple users
        - 0 — A text channel within a server
        - 2 — A voice channel within a server
        - 4 — An organizational category that contains up to 50 channels
        - 5 — A channel that users can follow and crosspost into their own server (formerly news channels)
        - 10 — A temporary sub-channel within a GUILD_ANNOUNCEMENT channel
        - 11 — A temporary sub-channel within a GUILD_TEXT or GUILD_THREADS_ONLY channel type set
        - 12 — A temporary sub-channel within a GUILD_TEXT channel that is only viewable by those invited and those with the MANAGE_THREADS permission
        - 13 — A voice channel for hosting events with an audience
        - 14 — The channel in a hub containing the listed servers
        - 15 — Channel that can only contain threads
      - `name` string, nullable, required
      - `icon` string
      - `recipients` InviteChannelRecipientResponse[]
        - `id` string, snowflake, required
        - `username` string, required
        - `avatar` string, nullable, required
    - `approximate_member_count` integer, nullable
  - GuildInviteResponse
    - `type` union, required
      - 0
      - 1
      - 2
    - `code` string, required
    - `inviter` UserResponse
      - `id` string, snowflake, required
      - `username` string, required — the user's username, not unique across the platform
      - `avatar` string, nullable, required — the user's avatar hash
      - `discriminator` string, required — the user's Discord-tag
      - `public_flags` integer, required — the public flags on a user's account
      - `flags` integer, required
      - `bot` boolean — whether the user belongs to an OAuth2 application
      - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system)
      - `banner` string, nullable — the user's banner hash
      - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code
      - `global_name` string, nullable, required — the user's display name, if it is set
      - `avatar_decoration_data` UserAvatarDecorationResponse
        - `asset` string, required — the avatar decoration hash
        - `sku_id` string, snowflake, required
      - `collectibles` UserCollectiblesResponse
        - `nameplate` UserNameplateResponse, required
          - `sku_id` string, snowflake, required
          - `asset` string, required — Path to the nameplate asset
          - `label` string, required — The label of this nameplate. Currently unused
          - `palette` union, required
            - 'crimson' — Crimson color palette
            - 'berry' — Berry color palette
            - 'sky' — Sky color palette
            - 'teal' — Teal color palette
            - 'forest' — Forest color palette
            - 'bubble_gum' — Bubble gum color palette
            - 'violet' — Violet color palette
            - 'cobalt' — Cobalt color palette
            - 'clover' — Clover color palette
            - 'lemon' — Lemon color palette
            - 'white' — White color palette
            - 'black' — Black color palette
      - `primary_guild` UserPrimaryGuildResponse, required
        - `identity_guild_id` string, snowflake, required
        - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag
        - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters
        - `badge` string, nullable, required — the server tag badge hash
    - `max_age` integer
    - `created_at` string, date-time
    - `expires_at` string, date-time, nullable, required
    - `is_contact` boolean
    - `flags` integer
    - `guild` InviteGuildResponse, required
      - `id` string, snowflake, required
      - `name` string, required
      - `splash` string, nullable, required
      - `banner` string, nullable, required
      - `description` string, nullable, required
      - `icon` string, nullable, required
      - `features` GuildFeatures[], required
        - union
          - 'ANIMATED_BANNER' — guild has access to set an animated guild banner image
          - 'ANIMATED_ICON' — guild has access to set an animated guild icon
          - 'APPLICATION_COMMAND_PERMISSIONS_V2' — guild is using the old permissions configuration behavior
          - 'AUTO_MODERATION' — guild has set up auto moderation rules
          - 'BANNER' — guild has access to set a guild banner image
          - 'COMMUNITY' — guild can enable welcome screen, Membership Screening, stage channels and discovery, and receives community updates
          - 'CREATOR_MONETIZABLE_PROVISIONAL' — guild has enabled monetization
          - 'CREATOR_STORE_PAGE' — guild has enabled the role subscription promo page
          - 'DEVELOPER_SUPPORT_SERVER' — guild has been set as a support server on the App Directory
          - 'DISCOVERABLE' — guild is able to be discovered in the directory
          - 'FEATURABLE' — guild is able to be featured in the directory
          - 'INVITES_DISABLED' — guild has paused invites, preventing new users from joining
          - 'INVITE_SPLASH' — guild has access to set an invite splash background
          - 'MEMBER_VERIFICATION_GATE_ENABLED' — guild has enabled Membership Screening
          - 'MORE_STICKERS' — guild has increased custom sticker slots
          - 'NEWS' — guild has access to create announcement channels
          - 'PARTNERED' — guild is partnered
          - 'PREVIEW_ENABLED' — guild can be previewed before joining via Membership Screening or the directory
          - 'RAID_ALERTS_DISABLED' — guild has disabled activity alerts in the configured safety alerts channel
          - 'PRUNE_REQUIRES_ADMIN' — guild has restricted member prune to administrators and the guild owner
          - 'ROLE_ICONS' — guild is able to set role icons
          - 'ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE' — guild has role subscriptions that can be purchased
          - 'ROLE_SUBSCRIPTIONS_ENABLED' — guild has enabled role subscriptions
          - 'TICKETED_EVENTS_ENABLED' — guild has enabled ticketed events
          - 'VANITY_URL' — guild has access to set a vanity URL
          - 'VERIFIED' — guild is verified
          - 'VIP_REGIONS' — guild has access to set 384kbps bitrate in voice (previously VIP voice servers)
          - 'WELCOME_SCREEN_ENABLED' — guild has enabled the welcome screen
          - 'OFFICIAL_GAME_GUILD' — guild is an official guild for one or more games
      - `verification_level` union, required
        - 0 — unrestricted
        - 1 — must have verified email on account
        - 2 — must be registered on Discord for longer than 5 minutes
        - 3 — must be a member of the server for longer than 10 minutes
        - 4 — must have a verified phone number
      - `vanity_url_code` string, nullable, required
      - `nsfw_level` union, required
        - 0
        - 1
        - 2
        - 3
      - `nsfw` boolean, nullable, required
      - `premium_subscription_count` integer, required
    - `guild_id` string, snowflake, required
    - `channel` InviteChannelResponse, required
      - `id` string, snowflake, required
      - `type` union, required
        - 1 — A direct message between users
        - 3 — A direct message between multiple users
        - 0 — A text channel within a server
        - 2 — A voice channel within a server
        - 4 — An organizational category that contains up to 50 channels
        - 5 — A channel that users can follow and crosspost into their own server (formerly news channels)
        - 10 — A temporary sub-channel within a GUILD_ANNOUNCEMENT channel
        - 11 — A temporary sub-channel within a GUILD_TEXT or GUILD_THREADS_ONLY channel type set
        - 12 — A temporary sub-channel within a GUILD_TEXT channel that is only viewable by those invited and those with the MANAGE_THREADS permission
        - 13 — A voice channel for hosting events with an audience
        - 14 — The channel in a hub containing the listed servers
        - 15 — Channel that can only contain threads
      - `name` string, nullable, required
      - `icon` string
      - `recipients` InviteChannelRecipientResponse[]
        - `id` string, snowflake, required
        - `username` string, required
        - `avatar` string, nullable, required
    - `target_type` union
      - 1
      - 2
      - 3
    - `target_user` UserResponse
      - `id` string, snowflake, required
      - `username` string, required — the user's username, not unique across the platform
      - `avatar` string, nullable, required — the user's avatar hash
      - `discriminator` string, required — the user's Discord-tag
      - `public_flags` integer, required — the public flags on a user's account
      - `flags` integer, required
      - `bot` boolean — whether the user belongs to an OAuth2 application
      - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system)
      - `banner` string, nullable — the user's banner hash
      - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code
      - `global_name` string, nullable, required — the user's display name, if it is set
      - `avatar_decoration_data` UserAvatarDecorationResponse
        - `asset` string, required — the avatar decoration hash
        - `sku_id` string, snowflake, required
      - `collectibles` UserCollectiblesResponse
        - `nameplate` UserNameplateResponse, required
          - `sku_id` string, snowflake, required
          - `asset` string, required — Path to the nameplate asset
          - `label` string, required — The label of this nameplate. Currently unused
          - `palette` union, required
            - 'crimson' — Crimson color palette
            - 'berry' — Berry color palette
            - 'sky' — Sky color palette
            - 'teal' — Teal color palette
            - 'forest' — Forest color palette
            - 'bubble_gum' — Bubble gum color palette
            - 'violet' — Violet color palette
            - 'cobalt' — Cobalt color palette
            - 'clover' — Clover color palette
            - 'lemon' — Lemon color palette
            - 'white' — White color palette
            - 'black' — Black color palette
      - `primary_guild` UserPrimaryGuildResponse, required
        - `identity_guild_id` string, snowflake, required
        - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag
        - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters
        - `badge` string, nullable, required — the server tag badge hash
    - `target_application` InviteApplicationResponse
      - `id` string, snowflake, required
      - `name` string, required
      - `icon` string, nullable, required
      - `description` string, required
      - `type` 4, required
      - `cover_image` string
      - `primary_sku_id` string, snowflake
      - `bot` UserResponse
        - `id` string, snowflake, required
        - `username` string, required — the user's username, not unique across the platform
        - `avatar` string, nullable, required — the user's avatar hash
        - `discriminator` string, required — the user's Discord-tag
        - `public_flags` integer, required — the public flags on a user's account
        - `flags` integer, required
        - `bot` boolean — whether the user belongs to an OAuth2 application
        - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system)
        - `banner` string, nullable — the user's banner hash
        - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code
        - `global_name` string, nullable, required — the user's display name, if it is set
        - `avatar_decoration_data` UserAvatarDecorationResponse
          - `asset` string, required — the avatar decoration hash
          - `sku_id` string, snowflake, required
        - `collectibles` UserCollectiblesResponse
          - `nameplate` UserNameplateResponse, required
            - `sku_id` string, snowflake, required
            - `asset` string, required — Path to the nameplate asset
            - `label` string, required — The label of this nameplate. Currently unused
            - `palette` union, required
              - …
        - `primary_guild` UserPrimaryGuildResponse, required
          - `identity_guild_id` string, snowflake, required
          - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag
          - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters
          - `badge` string, nullable, required — the server tag badge hash
      - `slug` string
      - `guild_id` string, snowflake
      - `rpc_origins` string[]
      - `bot_public` boolean
      - `bot_require_code_grant` boolean
      - `terms_of_service_url` string, uri
      - `privacy_policy_url` string, uri
      - `custom_install_url` string, uri
      - `install_params` ApplicationOAuth2InstallParamsResponse
        - `scopes` OAuth2Scopes[], required
          - union
            - 'identify' — allows /users/@me without email
            - 'email' — enables /users/@me to return an email
            - 'connections' — allows /users/@me/connections to return linked third-party accounts
            - 'guilds' — allows /users/@me/guilds to return basic information about all of a user's guilds
            - 'guilds.join' — allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
            - 'guilds.members.read' — allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
            - 'gdm.join' — allows your app to join users to a group dm
            - 'bot' — for oauth2 bots, this puts the bot in the user's selected guild by default
            - 'rpc' — for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
            - 'rpc.notifications.read' — for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
            - 'rpc.voice.read' — for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
            - 'rpc.voice.write' — for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
            - 'rpc.video.read' — for local rpc server access, this allows you to read a user's video status - requires Discord approval
            - 'rpc.video.write' — for local rpc server access, this allows you to update a user's video settings - requires Discord approval
            - 'rpc.screenshare.read' — for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
            - 'rpc.screenshare.write' — for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
            - 'rpc.activities.write' — for local rpc server access, this allows you to update a user's activity - requires Discord approval
            - 'webhook.incoming' — this generates a webhook that is returned in the oauth token response for authorization code grants
            - 'messages.read' — for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
            - 'applications.builds.upload' — allows your app to upload/update builds for a user's applications - requires Discord approval
            - 'applications.builds.read' — allows your app to read build data for a user's applications
            - 'applications.commands' — allows your app to use commands in a guild
            - 'applications.commands.permissions.update' — allows your app to update permissions for its commands in a guild a user has permissions to
            - 'applications.commands.update' — allows your app to update its commands using a Bearer token - client credentials grant only
            - 'applications.store.update' — allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
            - 'applications.entitlements' — allows your app to read entitlements for a user's applications
            - 'activities.read' — allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
            - 'activities.write' — allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
            - 'activities.invites.write' — allows your app to send activity invites - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
            - 'relationships.read' — allows your app to know a user's friends and implicit relationships - requires Discord approval
            - 'voice' — allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
            - 'dm_channels.read' — allows your app to see information about the user's DMs and group DMs - requires Discord approval
            - 'role_connections.write' — allows your app to update a user's connection and metadata for the app
            - 'openid' — for OpenID Connect, this allows your app to receive user id and basic profile information
        - `permissions` string, required
      - `integration_types_config` object
      - `verify_key` string, required
      - `flags` integer, required
      - `flags_new` string, required
      - `max_participants` integer, nullable
      - `tags` string[]
    - `guild_scheduled_event` ScheduledEventResponse
      - `id` string, snowflake, required
      - `guild_id` string, snowflake, required
      - `name` string, required — Name of the scheduled event
      - `description` string, nullable, required — Description of the scheduled event
      - `channel_id` string, snowflake, required
      - `creator_id` string, snowflake, required
      - `creator` UserResponse
        - `id` string, snowflake, required
        - `username` string, required — the user's username, not unique across the platform
        - `avatar` string, nullable, required — the user's avatar hash
        - `discriminator` string, required — the user's Discord-tag
        - `public_flags` integer, required — the public flags on a user's account
        - `flags` integer, required
        - `bot` boolean — whether the user belongs to an OAuth2 application
        - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system)
        - `banner` string, nullable — the user's banner hash
        - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code
        - `global_name` string, nullable, required — the user's display name, if it is set
        - `avatar_decoration_data` UserAvatarDecorationResponse
          - `asset` string, required — the avatar decoration hash
          - `sku_id` string, snowflake, required
        - `collectibles` UserCollectiblesResponse
          - `nameplate` UserNameplateResponse, required
            - `sku_id` string, snowflake, required
            - `asset` string, required — Path to the nameplate asset
            - `label` string, required — The label of this nameplate. Currently unused
            - `palette` union, required
              - …
        - `primary_guild` UserPrimaryGuildResponse, required
          - `identity_guild_id` string, snowflake, required
          - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag
          - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters
          - `badge` string, nullable, required — the server tag badge hash
      - `image` string, nullable, required — Cover image hash of the scheduled event
      - `scheduled_start_time` string, date-time, required — When the scheduled event will start
      - `scheduled_end_time` string, date-time, nullable, required — When the scheduled event will end, or null if no end time
      - `status` union, required
        - 1
        - 2
        - 3
        - 4
      - `entity_type` union, required
        - 0
        - 1
        - 2
        - 3
      - `entity_id` string, snowflake, required
      - `recurrence_rule` RecurrenceRuleResponse, required
        - `start` string, date-time, required — Starting time of the recurrence interval
        - `end` string, date-time, nullable — Ending time of the recurrence interval
        - `frequency` union, required
          - 3
          - 2
          - 1
          - 0
        - `interval` integer, required — The spacing between events, defined by frequency
        - `by_weekday` RecurrenceRuleWeekdays[], nullable, required — Set of specific days within a week for the event to recur on
          - union
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
        - `by_n_weekday` ByNWeekdayResponse[], nullable, required — List of specific days within a specific week to recur on
          - `n` integer, required — The week to reoccur on (1-5, where 5 represents the last week)
          - `day` union, required
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
        - `by_month` RecurrenceRuleMonths[], nullable, required — Set of specific months to recur on
          - union
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
        - `by_month_day` integer[], nullable, required — Set of specific dates within a month to recur on
        - `by_year_day` integer[], nullable — Set of days within a year to recur on (1-364)
        - `count` integer, nullable — Total number of times the event is allowed to recur
      - `user_count` integer — Number of users subscribed to the scheduled event
      - `privacy_level` 2, required — the scheduled event is only accessible to guild members
      - `user_rsvp` ScheduledEventUserResponse
        - `guild_scheduled_event_id` string, snowflake, required
        - `guild_scheduled_event_exception_id` string, snowflake
        - `user_id` string, snowflake, required
        - `user` UserResponse
          - `id` string, snowflake, required
          - `username` string, required — the user's username, not unique across the platform
          - `avatar` string, nullable, required — the user's avatar hash
          - `discriminator` string, required — the user's Discord-tag
          - `public_flags` integer, required — the public flags on a user's account
          - `flags` integer, required
          - `bot` boolean — whether the user belongs to an OAuth2 application
          - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system)
          - `banner` string, nullable — the user's banner hash
          - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code
          - `global_name` string, nullable, required — the user's display name, if it is set
          - `avatar_decoration_data` UserAvatarDecorationResponse
            - `asset` string, required — the avatar decoration hash
            - `sku_id` string, snowflake, required
          - `collectibles` UserCollectiblesResponse
            - `nameplate` UserNameplateResponse, required
              - …
          - `primary_guild` UserPrimaryGuildResponse, required
            - `identity_guild_id` string, snowflake, required
            - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag
            - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters
            - `badge` string, nullable, required — the server tag badge hash
        - `member` GuildMemberResponse
          - `avatar` string, nullable, required — the member's guild avatar hash
          - `avatar_decoration_data` UserAvatarDecorationResponse
            - `asset` string, required — the avatar decoration hash
            - `sku_id` string, snowflake, required
          - `banner` string, nullable, required — the member's guild banner hash
          - `communication_disabled_until` string, date-time, nullable, required — when the user's timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out
          - `flags` integer, required — guild member flags represented as a bit set, defaults to 0
          - `joined_at` string, date-time, required — when the user joined the guild
          - `nick` string, nullable, required — this user's guild nickname
          - `pending` boolean, required — whether the user has not yet passed the guild's Membership Screening requirements
          - `premium_since` string, date-time, nullable, required — when the user started boosting the guild
          - `roles` SnowflakeType[], required — array of role object ids
          - `collectibles` UserCollectiblesResponse
            - `nameplate` UserNameplateResponse, required
              - …
          - `user` UserResponse, required
            - `id` string, snowflake, required
            - `username` string, required — the user's username, not unique across the platform
            - `avatar` string, nullable, required — the user's avatar hash
            - `discriminator` string, required — the user's Discord-tag
            - `public_flags` integer, required — the public flags on a user's account
            - `flags` integer, required
            - `bot` boolean — whether the user belongs to an OAuth2 application
            - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system)
            - `banner` string, nullable — the user's banner hash
            - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code
            - `global_name` string, nullable, required — the user's display name, if it is set
            - `avatar_decoration_data` UserAvatarDecorationResponse
              - …
            - `collectibles` UserCollectiblesResponse
              - …
            - `primary_guild` UserPrimaryGuildResponse, required
              - …
          - `mute` boolean, required — whether the user is muted in voice channels
          - `deaf` boolean, required — whether the user is deafened in voice channels
        - `response` union, required
          - 0 — User is not interested in the event
          - 1 — User is interested in the event
      - `guild_scheduled_event_exceptions` GuildScheduledEventExceptionResponse[], required
        - `event_id` string, snowflake, required
        - `event_exception_id` string, snowflake, required
        - `scheduled_start_time` string, date-time, nullable, required — Overridden start time of this occurrence
        - `scheduled_end_time` string, date-time, nullable, required — Overridden end time of this occurrence
        - `is_canceled` boolean, required — Whether this occurrence is canceled
    - `target_channel_id` string, snowflake
    - `target_message_id` string, snowflake
    - `liveliness` GuildLivelinessResponse
      - `msg_activity_bins` integer[], required
      - `last_updated_ts` string, date-time, nullable
    - `uses` integer
    - `max_uses` integer
    - `temporary` boolean
    - `approximate_member_count` integer, nullable
    - `approximate_presence_count` integer, nullable
    - `is_nickname_changeable` boolean
    - `roles` InviteGuildRoleResponse[], nullable
      - `id` string, snowflake, required
      - `name` string, required
      - `position` integer, required
      - `color` integer, required
      - `colors` GuildRoleColorsResponse, required
        - `primary_color` integer, required
        - `secondary_color` integer, nullable, required
        - `tertiary_color` integer, nullable, required
      - `icon` string, nullable, required
      - `unicode_emoji` string, nullable, required
      - `permissions` string

## Other responses

- `429` — Client ratelimited response
- `4XX` — Client error response

---

[API](https://skmtc.net/discord/apis/discord-http-api-preview.md) · [All operations](https://skmtc.net/discord/apis/discord-http-api-preview/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/discord/discord-http-api-preview/revisions/37e3f56d2668/schema)
