--- title: "List guild invites" method: GET path: "/guilds/{guild_id}/invites" tags: ["Invites"] --- # List guild invites `GET /guilds/{guild_id}/invites` Retrieves all currently active invites across all channels in the specified guild, including invite codes, creators, expiration times, and usage statistics. The authenticated user must have permission to manage invites for the guild. Returns an array of invite metadata objects. ## Path parameters - `guild_id` string, snowflake, required ## Response `200` Success - InviteMetadataResponseSchema[] - union - GuildInviteMetadataResponse - `code` string, required — The unique invite code - `type` 0, required — The type of invite (guild) - `guild` object, required — The guild this invite is for - `id` string, required — The unique identifier for this guild - `name` string, required — The name of the guild - `icon` string, nullable — The hash of the guild icon - `banner` string, nullable — The hash of the guild banner - `banner_width` integer - `banner_height` integer - `splash` string, nullable — The hash of the guild splash screen - `splash_width` integer - `splash_height` integer - `splash_card_alignment` 0 | 1 | 2, required — The alignment of the splash card - `embed_splash` string, nullable — The hash of the embedded invite splash - `embed_splash_width` integer - `embed_splash_height` integer - `features` GuildFeatureSchema[], required — Array of guild feature flags - `channel` ChannelPartialResponse, required - `id` string, required — The unique identifier (snowflake) for this channel - `name` string, nullable — The name of the channel - `type` integer, required — The type of the channel - `recipients` object[] — The recipients of the DM channel - `username` string, required — The username of the recipient - `inviter` UserPartialResponse - `id` string, required — The unique identifier (snowflake) for this user - `username` string, required — The username of the user, not unique across the platform - `discriminator` string, required — The four-digit discriminator tag of the user - `global_name` string, nullable, required — The display name of the user, if set - `avatar` string, nullable, required — The hash of the user avatar image - `avatar_color` integer, required - `bot` boolean — Whether the user is a bot account - `system` boolean — Whether the user is an official system user - `flags` integer, required — The public flags on the user account - `mention_flags` 0 | 1 | 2 — Reply mention preference - `member_count` integer, required — The approximate total member count of the guild - `presence_count` integer, required — The approximate online member count of the guild - `expires_at` string, date-time, nullable — ISO8601 timestamp of when the invite expires - `temporary` boolean, required — Whether the invite grants temporary membership - `created_at` string, date-time, required — ISO8601 timestamp of when the invite was created - `uses` integer, required — The number of times this invite has been used - `max_uses` integer, required — The maximum number of times this invite can be used - `max_age` integer, required — The duration in seconds before the invite expires - GroupDmInviteMetadataResponse - `code` string, required — The unique invite code - `type` 1, required — The type of invite (group DM) - `channel` ChannelPartialResponse, required - `id` string, required — The unique identifier (snowflake) for this channel - `name` string, nullable — The name of the channel - `type` integer, required — The type of the channel - `recipients` object[] — The recipients of the DM channel - `username` string, required — The username of the recipient - `inviter` UserPartialResponse - `id` string, required — The unique identifier (snowflake) for this user - `username` string, required — The username of the user, not unique across the platform - `discriminator` string, required — The four-digit discriminator tag of the user - `global_name` string, nullable, required — The display name of the user, if set - `avatar` string, nullable, required — The hash of the user avatar image - `avatar_color` integer, required - `bot` boolean — Whether the user is a bot account - `system` boolean — Whether the user is an official system user - `flags` integer, required — The public flags on the user account - `mention_flags` 0 | 1 | 2 — Reply mention preference - `member_count` integer, required — The current member count of the group DM - `expires_at` string, date-time, nullable — ISO8601 timestamp of when the invite expires - `temporary` boolean, required — Whether the invite grants temporary membership - `created_at` string, date-time, required — ISO8601 timestamp of when the invite was created - `uses` integer, required — The number of times this invite has been used - `max_uses` integer, required — The maximum number of times this invite can be used - PackInviteMetadataResponse - `code` string, required — The unique invite code - `type` 2 | 3, required — The type of pack invite (emoji or sticker pack) - `pack` object, required — The pack this invite is for - `id` string, required — The unique identifier for the pack - `name` string, required — The display name of the pack - `description` string, nullable — The description of the pack - `type` 'emoji' | 'sticker', required — The type of pack (emoji or sticker) - `creator_id` string, required — The ID of the user who created the pack - `created_at` string, date-time, required — ISO8601 timestamp of when the pack was created - `updated_at` string, date-time, required — ISO8601 timestamp of when the pack was last updated - `creator` UserPartialResponse, required - `id` string, required — The unique identifier (snowflake) for this user - `username` string, required — The username of the user, not unique across the platform - `discriminator` string, required — The four-digit discriminator tag of the user - `global_name` string, nullable, required — The display name of the user, if set - `avatar` string, nullable, required — The hash of the user avatar image - `avatar_color` integer, required - `bot` boolean — Whether the user is a bot account - `system` boolean — Whether the user is an official system user - `flags` integer, required — The public flags on the user account - `mention_flags` 0 | 1 | 2 — Reply mention preference - `inviter` UserPartialResponse - `id` string, required — The unique identifier (snowflake) for this user - `username` string, required — The username of the user, not unique across the platform - `discriminator` string, required — The four-digit discriminator tag of the user - `global_name` string, nullable, required — The display name of the user, if set - `avatar` string, nullable, required — The hash of the user avatar image - `avatar_color` integer, required - `bot` boolean — Whether the user is a bot account - `system` boolean — Whether the user is an official system user - `flags` integer, required — The public flags on the user account - `mention_flags` 0 | 1 | 2 — Reply mention preference - `expires_at` string, date-time, nullable — ISO8601 timestamp of when the invite expires - `temporary` boolean, required — Whether the invite grants temporary access - `created_at` string, date-time, required — ISO8601 timestamp of when the invite was created - `uses` integer, required — The number of times this invite has been used - `max_uses` integer, required — The maximum number of times this invite can be used ## Other responses - `400` — Bad Request - The request was malformed or contained invalid data - `401` — Unauthorized - Authentication is required or the token is invalid - `403` — Forbidden - You do not have permission to perform this action - `429` — Too Many Requests - You are being rate limited - `500` — Internal Server Error - An unexpected error occurred --- [API](https://skmtc.dev/fluxer/apis/fluxer-api.md) · [All operations](https://skmtc.dev/fluxer/apis/fluxer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fluxer/fluxer-api/revisions/d9c706133cc5/schema)