--- title: "GET /channels/{channel_id}/messages/pins" method: GET path: "/channels/{channel_id}/messages/pins" --- # GET /channels/{channel_id}/messages/pins `GET /channels/{channel_id}/messages/pins` ## Query parameters - `before` string, date-time - `limit` integer ## Response `200` 200 response for list_pins - PinnedMessagesResponse - `items` PinnedMessageResponse[], required - `pinned_at` string, date-time, required - `message` MessageResponse, required - `type` union, required - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 31 - 32 - 36 - 37 - 38 - 39 - 46 - 55 - `content` string, required - `mentions` 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 - `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 - `mention_roles` SnowflakeType[], required - `attachments` MessageAttachmentResponse[], required - `id` string, snowflake, required - `filename` string, required - `size` integer, required - `url` string, uri, required - `proxy_url` string, uri, required - `width` integer - `height` integer - `duration_secs` number, double - `waveform` string - `description` string - `content_type` string - `ephemeral` boolean - `flags` integer - `placeholder` string - `placeholder_version` integer - `title` string, nullable - `application` ApplicationResponse - `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 - … - `collectibles` UserCollectiblesResponse - … - `primary_guild` UserPrimaryGuildResponse, required - … - `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 - … - `permissions` string, required - `integration_types_config` object - `verify_key` string, required - `flags` integer, required - `flags_new` string, required - `max_participants` integer, nullable - `tags` string[] - `clip_created_at` string, date-time - `clip_participants` 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 - `embeds` MessageEmbedResponse[], required - `type` string, required - `url` string, uri - `title` string - `description` string - `color` integer - `timestamp` string, date-time - `fields` MessageEmbedFieldResponse[] - `name` string, required - `value` string, required - `inline` boolean, required - `author` MessageEmbedAuthorResponse - `name` string, required - `url` string - `icon_url` string - `proxy_icon_url` string, uri - `provider` MessageEmbedProviderResponse - `name` string, required - `url` string, uri - `image` MessageEmbedImageResponse - `url` string - `proxy_url` string, uri - `width` integer - `height` integer - `content_type` string - `placeholder` string - `placeholder_version` integer - `description` string - `flags` integer - `thumbnail` MessageEmbedImageResponse - `url` string - `proxy_url` string, uri - `width` integer - `height` integer - `content_type` string - `placeholder` string - `placeholder_version` integer - `description` string - `flags` integer - `video` MessageEmbedVideoResponse - `url` string - `proxy_url` string, uri - `width` integer - `height` integer - `content_type` string - `placeholder` string - `placeholder_version` integer - `description` string - `flags` integer - `footer` MessageEmbedFooterResponse - `text` string, required - `icon_url` string - `proxy_icon_url` string, uri - `flags` integer, nullable - `components` ContainerComponentResponse[] - `type` union, required - 1 — Container for other components - 2 — Button object - 3 — Select menu for picking from defined text options - 4 — Text input object - 5 — Select menu for users - 6 — Select menu for roles - 7 — Select menu for mentionables (users and roles) - 8 — Select menu for channels - 9 — Section component - 10 — Text component - 11 — Thumbnail component - 12 — Media gallery component - 13 — File component - 14 — Separator component - 17 — Container component - 18 — Label component - 19 — File upload component - 21 — Radio group component - 22 — Checkbox group component - 23 — Checkbox component - `id` integer, required - `accent_color` integer, nullable, required - `components` union[], required - union - … - `spoiler` boolean, required - `timestamp` string, date-time, required - `edited_timestamp` string, date-time, nullable, required - `flags` integer, required - `components` union[], required - union - ActionRowComponentResponse - `type` union, required - … - `id` integer, required - `components` union[], required - … - ContainerComponentResponse - `type` union, required - … - `id` integer, required - `accent_color` integer, nullable, required - `components` union[], required - … - `spoiler` boolean, required - FileComponentResponse - `type` union, required - … - `id` integer, required - `file` UnfurledMediaResponse, required - … - `name` string, nullable, required - `size` integer, nullable, required - `spoiler` boolean, required - MediaGalleryComponentResponse - `type` union, required - … - `id` integer, required - `items` MediaGalleryItemResponse[], required - … - SectionComponentResponse - `type` union, required - … - `id` integer, required - `components` TextDisplayComponentResponse[], required - … - `accessory` union, required - … - SeparatorComponentResponse - `type` union, required - … - `id` integer, required - `spacing` union, required - … - `divider` boolean, required - TextDisplayComponentResponse - `type` union, required - … - `id` integer, required - `content` string, required - `stickers` union[] - union - GuildStickerResponse - `id` string, snowflake, required - `name` string, required - `tags` string, required - `type` union, required - … - `format_type` union, required - … - `description` string, nullable, required - `available` boolean, required - `guild_id` string, snowflake, required - `user` UserResponse - … - StandardStickerResponse - `id` string, snowflake, required - `name` string, required - `tags` string, required - `type` union, required - … - `format_type` union, required - … - `description` string, nullable, required - `pack_id` string, snowflake, required - `sort_value` integer, required - `sticker_items` MessageStickerItemResponse[] - `id` string, snowflake, required - `name` string, required - `format_type` union, required - 1 - 2 - 3 - 4 - `id` string, snowflake, required - `channel_id` string, snowflake, required - `author` 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 - `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 - `pinned` boolean, required - `mention_everyone` boolean, required - `tts` boolean, required - `call` MessageCallResponse - `ended_timestamp` string, date-time, nullable - `participants` SnowflakeType[], required - `activity` MessageActivityResponse - `type` union, required - 1 - 2 - 3 - 5 - 6 - `party_id` string - `application` BasicApplicationResponseWithBot - `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 - … - `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 - `application_id` string, snowflake - `interaction` MessageInteractionResponse - `id` string, snowflake, required - `type` union, required - 1 — Sent by Discord to validate your application's interaction handler - 2 — Sent when a user uses an application command - 3 — Sent when a user interacts with a message component previously sent by your application - 4 — Sent when a user is filling in an autocomplete option in a chat command - 5 — Sent when a user submits a modal previously sent by your application - 6 — Sent when Discord is checking if a user can purchase a Social Layer SKU - `name` string, 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 - `name_localized` string - `nonce` union - integer - string, nonce - `webhook_id` string, snowflake - `message_reference` MessageReferenceResponse - `type` 0, required — Reference to a message - `channel_id` string, snowflake, required - `message_id` string, snowflake - `guild_id` string, snowflake - `thread` ThreadResponse - `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 - `last_message_id` string, snowflake - `flags` integer, required - `last_pin_timestamp` string, date-time, nullable - `guild_id` string, snowflake, required - `name` string, required - `parent_id` string, snowflake - `rate_limit_per_user` integer - `bitrate` integer - `user_limit` integer - `rtc_region` string, nullable - `video_quality_mode` union - 1 — Discord chooses the quality for optimal performance - 2 — 720p - `permissions` string - `owner_id` string, snowflake, required - `thread_metadata` ThreadMetadataResponse, required - `archived` boolean, required - `archive_timestamp` string, date-time, nullable, required - `auto_archive_duration` union, required - 60 — One hour - 1440 — One day - 4320 — Three days - 10080 — Seven days - `locked` boolean, required - `create_timestamp` string, date-time - `invitable` boolean - `message_count` integer, required - `member_count` integer, required - `total_message_sent` integer, required - `applied_tags` SnowflakeType[] - `member` ThreadMemberResponse - `id` string, snowflake, required - `user_id` string, snowflake, required - `join_timestamp` string, date-time, required - `flags` integer, required - `member` GuildMemberResponse - `avatar` string, nullable, required — the member's guild avatar hash - `avatar_decoration_data` UserAvatarDecorationResponse - … - `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 - … - `user` UserResponse, required - … - `mute` boolean, required — whether the user is muted in voice channels - `deaf` boolean, required — whether the user is deafened in voice channels - `mention_channels` MessageMentionChannelResponse[] - `id` string, snowflake, required - `name` string, 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 - `guild_id` string, snowflake, required - `role_subscription_data` MessageRoleSubscriptionDataResponse - `role_subscription_listing_id` string, snowflake, required - `tier_name` string, required - `total_months_subscribed` integer, required - `is_renewal` boolean, required - `purchase_notification` PurchaseNotificationResponse - `type` 0, required - `guild_product_purchase` GuildProductPurchaseResponse - `listing_id` string, snowflake, required - `product_name` string, required - `position` integer - `resolved` ResolvedObjectsResponse - `users` object, nullable - `members` object, nullable - `channels` object, nullable - `roles` object, nullable - `poll` PollResponse - `question` PollMediaResponse, required - `text` string — The text of the field - `emoji` MessageReactionEmojiResponse - `id` string, snowflake, required - `name` string, nullable, required - `animated` boolean - `answers` PollAnswerResponse[], required — Each of the answers available in the poll - `answer_id` integer, required — The ID of the answer - `poll_media` PollMediaResponse, required - `text` string — The text of the field - `emoji` MessageReactionEmojiResponse - … - `expiry` string, date-time, required — The time when the poll ends - `allow_multiselect` boolean, required — Whether a user can select multiple answers - `layout_type` 1, required — The, uhm, default layout type. - `results` PollResultsResponse, required - `answer_counts` PollResultsEntryResponse[], required — The counts for each answer - `id` integer, required — The answer_id - `count` integer, required — The number of votes for this answer - `me_voted` boolean, required — Whether the current user voted for this answer - `is_finalized` boolean, required — Whether the votes have been precisely counted - `shared_client_theme` CustomClientThemeResponse - `colors` string[], required - `gradient_angle` integer, required - `base_mix` integer, required - `base_theme` union, required - 0 — No base theme - 1 — Dark base theme - 2 — Light base theme - 3 — Darker base theme - 4 — Midnight base theme - `interaction_metadata` union - ApplicationCommandInteractionMetadataResponse - `id` string, snowflake, required - `type` union, required - 1 — Sent by Discord to validate your application's interaction handler - 2 — Sent when a user uses an application command - 3 — Sent when a user interacts with a message component previously sent by your application - 4 — Sent when a user is filling in an autocomplete option in a chat command - 5 — Sent when a user submits a modal previously sent by your application - 6 — Sent when Discord is checking if a user can purchase a Social Layer SKU - `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 - … - `collectibles` UserCollectiblesResponse - … - `primary_guild` UserPrimaryGuildResponse, required - … - `authorizing_integration_owners` object, required - `original_response_message_id` string, snowflake - `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 - … - `collectibles` UserCollectiblesResponse - … - `primary_guild` UserPrimaryGuildResponse, required - … - `target_message_id` string, snowflake - MessageComponentInteractionMetadataResponse - `id` string, snowflake, required - `type` union, required - 1 — Sent by Discord to validate your application's interaction handler - 2 — Sent when a user uses an application command - 3 — Sent when a user interacts with a message component previously sent by your application - 4 — Sent when a user is filling in an autocomplete option in a chat command - 5 — Sent when a user submits a modal previously sent by your application - 6 — Sent when Discord is checking if a user can purchase a Social Layer SKU - `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 - … - `collectibles` UserCollectiblesResponse - … - `primary_guild` UserPrimaryGuildResponse, required - … - `authorizing_integration_owners` object, required - `original_response_message_id` string, snowflake - `interacted_message_id` string, snowflake, required - ModalSubmitInteractionMetadataResponse - `id` string, snowflake, required - `type` union, required - 1 — Sent by Discord to validate your application's interaction handler - 2 — Sent when a user uses an application command - 3 — Sent when a user interacts with a message component previously sent by your application - 4 — Sent when a user is filling in an autocomplete option in a chat command - 5 — Sent when a user submits a modal previously sent by your application - 6 — Sent when Discord is checking if a user can purchase a Social Layer SKU - `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 - … - `collectibles` UserCollectiblesResponse - … - `primary_guild` UserPrimaryGuildResponse, required - … - `authorizing_integration_owners` object, required - `original_response_message_id` string, snowflake - `triggering_interaction_metadata` union, required - ApplicationCommandInteractionMetadataResponse - … - MessageComponentInteractionMetadataResponse - … - `message_snapshots` MessageSnapshotResponse[] - `message` MinimalContentMessageResponse, required - `type` union, required - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 31 - 32 - 36 - 37 - 38 - 39 - 46 - 55 - `content` string, required - `mentions` 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 - … - `mention_roles` SnowflakeType[], required - `attachments` MessageAttachmentResponse[], required - `id` string, snowflake, required - `filename` string, required - `size` integer, required - `url` string, uri, required - `proxy_url` string, uri, required - `width` integer - `height` integer - `duration_secs` number, double - `waveform` string - `description` string - `content_type` string - `ephemeral` boolean - `flags` integer - `placeholder` string - `placeholder_version` integer - `title` string, nullable - `application` ApplicationResponse - … - `clip_created_at` string, date-time - `clip_participants` UserResponse[] - … - `embeds` MessageEmbedResponse[], required - `type` string, required - `url` string, uri - `title` string - `description` string - `color` integer - `timestamp` string, date-time - `fields` MessageEmbedFieldResponse[] - … - `author` MessageEmbedAuthorResponse - … - `provider` MessageEmbedProviderResponse - … - `image` MessageEmbedImageResponse - … - `thumbnail` MessageEmbedImageResponse - … - `video` MessageEmbedVideoResponse - … - `footer` MessageEmbedFooterResponse - … - `flags` integer, nullable - `components` ContainerComponentResponse[] - … - `timestamp` string, date-time, required - `edited_timestamp` string, date-time, nullable, required - `flags` integer, required - `components` union[], required - union - … - `stickers` union[] - union - … - `sticker_items` MessageStickerItemResponse[] - `id` string, snowflake, required - `name` string, required - `format_type` union, required - … - `lobby_member` MessageLobbyMemberResponse - `additional_name` string, required - `reactions` MessageReactionResponse[] - `emoji` MessageReactionEmojiResponse, required - `id` string, snowflake, required - `name` string, nullable, required - `animated` boolean - `count` integer, required - `count_details` MessageReactionCountDetailsResponse, required - `burst` integer, required - `normal` integer, required - `burst_colors` string[], required - `me_burst` boolean, required - `me` boolean, required - `referenced_message` BasicMessageResponse - `type` union, required - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 31 - 32 - 36 - 37 - 38 - 39 - 46 - 55 - `content` string, required - `mentions` 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 - `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 - `mention_roles` SnowflakeType[], required - `attachments` MessageAttachmentResponse[], required - `id` string, snowflake, required - `filename` string, required - `size` integer, required - `url` string, uri, required - `proxy_url` string, uri, required - `width` integer - `height` integer - `duration_secs` number, double - `waveform` string - `description` string - `content_type` string - `ephemeral` boolean - `flags` integer - `placeholder` string - `placeholder_version` integer - `title` string, nullable - `application` ApplicationResponse - `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 - … - `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 - … - `integration_types_config` object - `verify_key` string, required - `flags` integer, required - `flags_new` string, required - `max_participants` integer, nullable - `tags` string[] - `clip_created_at` string, date-time - `clip_participants` 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 - … - `collectibles` UserCollectiblesResponse - … - `primary_guild` UserPrimaryGuildResponse, required - … - `embeds` MessageEmbedResponse[], required - `type` string, required - `url` string, uri - `title` string - `description` string - `color` integer - `timestamp` string, date-time - `fields` MessageEmbedFieldResponse[] - `name` string, required - `value` string, required - `inline` boolean, required - `author` MessageEmbedAuthorResponse - `name` string, required - `url` string - `icon_url` string - `proxy_icon_url` string, uri - `provider` MessageEmbedProviderResponse - `name` string, required - `url` string, uri - `image` MessageEmbedImageResponse - `url` string - `proxy_url` string, uri - `width` integer - `height` integer - `content_type` string - `placeholder` string - `placeholder_version` integer - `description` string - `flags` integer - `thumbnail` MessageEmbedImageResponse - `url` string - `proxy_url` string, uri - `width` integer - `height` integer - `content_type` string - `placeholder` string - `placeholder_version` integer - `description` string - `flags` integer - `video` MessageEmbedVideoResponse - `url` string - `proxy_url` string, uri - `width` integer - `height` integer - `content_type` string - `placeholder` string - `placeholder_version` integer - `description` string - `flags` integer - `footer` MessageEmbedFooterResponse - `text` string, required - `icon_url` string - `proxy_icon_url` string, uri - `flags` integer, nullable - `components` ContainerComponentResponse[] - `type` union, required - … - `id` integer, required - `accent_color` integer, nullable, required - `components` union[], required - … - `spoiler` boolean, required - `timestamp` string, date-time, required - `edited_timestamp` string, date-time, nullable, required - `flags` integer, required - `components` union[], required - union - ActionRowComponentResponse - … - ContainerComponentResponse - … - FileComponentResponse - … - MediaGalleryComponentResponse - … - SectionComponentResponse - … - SeparatorComponentResponse - … - TextDisplayComponentResponse - … - `stickers` union[] - union - GuildStickerResponse - … - StandardStickerResponse - … - `sticker_items` MessageStickerItemResponse[] - `id` string, snowflake, required - `name` string, required - `format_type` union, required - 1 - 2 - 3 - 4 - `id` string, snowflake, required - `channel_id` string, snowflake, required - `author` 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 - `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 - `pinned` boolean, required - `mention_everyone` boolean, required - `tts` boolean, required - `call` MessageCallResponse - `ended_timestamp` string, date-time, nullable - `participants` SnowflakeType[], required - `activity` MessageActivityResponse - `type` union, required - 1 - 2 - 3 - 5 - 6 - `party_id` string - `application` BasicApplicationResponseWithBot - `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 - … - `collectibles` UserCollectiblesResponse - … - `primary_guild` UserPrimaryGuildResponse, required - … - `application_id` string, snowflake - `interaction` MessageInteractionResponse - `id` string, snowflake, required - `type` union, required - 1 — Sent by Discord to validate your application's interaction handler - 2 — Sent when a user uses an application command - 3 — Sent when a user interacts with a message component previously sent by your application - 4 — Sent when a user is filling in an autocomplete option in a chat command - 5 — Sent when a user submits a modal previously sent by your application - 6 — Sent when Discord is checking if a user can purchase a Social Layer SKU - `name` string, 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 - … - `collectibles` UserCollectiblesResponse - … - `primary_guild` UserPrimaryGuildResponse, required - … - `name_localized` string - `nonce` union - integer - string, nonce - `webhook_id` string, snowflake - `message_reference` MessageReferenceResponse - `type` 0, required — Reference to a message - `channel_id` string, snowflake, required - `message_id` string, snowflake - `guild_id` string, snowflake - `thread` ThreadResponse - `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 - `last_message_id` string, snowflake - `flags` integer, required - `last_pin_timestamp` string, date-time, nullable - `guild_id` string, snowflake, required - `name` string, required - `parent_id` string, snowflake - `rate_limit_per_user` integer - `bitrate` integer - `user_limit` integer - `rtc_region` string, nullable - `video_quality_mode` union - 1 — Discord chooses the quality for optimal performance - 2 — 720p - `permissions` string - `owner_id` string, snowflake, required - `thread_metadata` ThreadMetadataResponse, required - `archived` boolean, required - `archive_timestamp` string, date-time, nullable, required - `auto_archive_duration` union, required - … - `locked` boolean, required - `create_timestamp` string, date-time - `invitable` boolean - `message_count` integer, required - `member_count` integer, required - `total_message_sent` integer, required - `applied_tags` SnowflakeType[] - `member` ThreadMemberResponse - `id` string, snowflake, required - `user_id` string, snowflake, required - `join_timestamp` string, date-time, required - `flags` integer, required - `member` GuildMemberResponse - … - `mention_channels` MessageMentionChannelResponse[] - `id` string, snowflake, required - `name` string, 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 - `guild_id` string, snowflake, required - `role_subscription_data` MessageRoleSubscriptionDataResponse - `role_subscription_listing_id` string, snowflake, required - `tier_name` string, required - `total_months_subscribed` integer, required - `is_renewal` boolean, required - `purchase_notification` PurchaseNotificationResponse - `type` 0, required - `guild_product_purchase` GuildProductPurchaseResponse - `listing_id` string, snowflake, required - `product_name` string, required - `position` integer - `resolved` ResolvedObjectsResponse - `users` object, nullable - `members` object, nullable - `channels` object, nullable - `roles` object, nullable - `poll` PollResponse - `question` PollMediaResponse, required - `text` string — The text of the field - `emoji` MessageReactionEmojiResponse - … - `answers` PollAnswerResponse[], required — Each of the answers available in the poll - `answer_id` integer, required — The ID of the answer - `poll_media` PollMediaResponse, required - … - `expiry` string, date-time, required — The time when the poll ends - `allow_multiselect` boolean, required — Whether a user can select multiple answers - `layout_type` 1, required — The, uhm, default layout type. - `results` PollResultsResponse, required - `answer_counts` PollResultsEntryResponse[], required — The counts for each answer - … - `is_finalized` boolean, required — Whether the votes have been precisely counted - `shared_client_theme` CustomClientThemeResponse - `colors` string[], required - `gradient_angle` integer, required - `base_mix` integer, required - `base_theme` union, required - 0 — No base theme - 1 — Dark base theme - 2 — Light base theme - 3 — Darker base theme - 4 — Midnight base theme - `interaction_metadata` union - ApplicationCommandInteractionMetadataResponse - `id` string, snowflake, required - `type` union, required - … - `user` UserResponse - … - `authorizing_integration_owners` object, required - `original_response_message_id` string, snowflake - `target_user` UserResponse - … - `target_message_id` string, snowflake - MessageComponentInteractionMetadataResponse - `id` string, snowflake, required - `type` union, required - … - `user` UserResponse - … - `authorizing_integration_owners` object, required - `original_response_message_id` string, snowflake - `interacted_message_id` string, snowflake, required - ModalSubmitInteractionMetadataResponse - `id` string, snowflake, required - `type` union, required - … - `user` UserResponse - … - `authorizing_integration_owners` object, required - `original_response_message_id` string, snowflake - `triggering_interaction_metadata` union, required - … - `message_snapshots` MessageSnapshotResponse[] - `message` MinimalContentMessageResponse, required - `type` union, required - … - `content` string, required - `mentions` UserResponse[], required - … - `mention_roles` SnowflakeType[], required - `attachments` MessageAttachmentResponse[], required - … - `embeds` MessageEmbedResponse[], required - … - `timestamp` string, date-time, required - `edited_timestamp` string, date-time, nullable, required - `flags` integer, required - `components` union[], required - … - `stickers` union[] - … - `sticker_items` MessageStickerItemResponse[] - … - `lobby_member` MessageLobbyMemberResponse - `additional_name` string, required - `has_more` boolean, required ## 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)