Endpoints

const Endpoints: object

Defined in: api/endpoints.ts:3

Type Declaration

applicationCommand()

applicationCommand: (applicationId, commandId) => `/applications/${string}/commands/${string}`

• GET
• PUT

Parameters

applicationId

string

commandId

string

Returns

`/applications/${string}/commands/${string}`

applicationCommandPermissions()

applicationCommandPermissions: (applicationId, guildId, commandId) => `/applications/${string}/guilds/${string}/commands/${string}/permissions`

• GET
• PUT

Parameters

applicationId

string

guildId

string

commandId

string

Returns

`/applications/${string}/guilds/${string}/commands/${string}/permissions`

applicationCommands()

applicationCommands: (applicationId) => `/applications/${string}/commands`

• GET
• PUT
• POST

Parameters

applicationId

string

Returns

`/applications/${string}/commands`

applicationEmoji()

applicationEmoji: (applicationId, emojiId) => `/applications/${string}/emojis/${string}`

• GET
• PUT

Parameters

applicationId

string

emojiId

string

Returns

`/applications/${string}/emojis/${string}`

applicationEmojis()

applicationEmojis: (applicationId) => `/applications/${string}/emojis`

• GET
• POST

Parameters

applicationId

string

Returns

`/applications/${string}/emojis`

applicationGuildCommand()

applicationGuildCommand: (applicationId, guildId, commandId) => `/applications/${string}/guilds/${string}/commands/${string}`

• GET
• PUT
• POST

Parameters

applicationId

string

guildId

string

commandId

string

Returns

`/applications/${string}/guilds/${string}/commands/${string}`

applicationGuildCommands()

applicationGuildCommands: (applicationId, guildId) => `/applications/${string}/guilds/${string}/commands`

• GET
• PUT
• POST

Parameters

applicationId

string

guildId

string

Returns

`/applications/${string}/guilds/${string}/commands`

applicationRoleConnectionMetadata()

applicationRoleConnectionMetadata: (applicationId) => `/applications/${string}/role-connections/metadata`

• GET
• PUT

Parameters

applicationId

string

Returns

`/applications/${string}/role-connections/metadata`

channel()

channel: (channelId) => `/channels/${string}`

• GET
• POST

Parameters

channelId

string

Returns

`/channels/${string}`

channelBulkDelete()

channelBulkDelete: (channelId) => `/channels/${string}/messages/bulk-delete`

• POST

Parameters

channelId

string

Returns

`/channels/${string}/messages/bulk-delete`

channelFollowers()

channelFollowers: (channelId) => `/channels/${string}/followers`

• POST

Parameters

channelId

string

Returns

`/channels/${string}/followers`

channelInvites()

channelInvites: (channelId) => `/channels/${string}/invites`

• GET
• POST

Parameters

channelId

string

Returns

`/channels/${string}/invites`

channelJoinedArchivedThreads()

channelJoinedArchivedThreads: (channelId) => `/channels/${string}/users/@me/threads/archived/private`

• GET

Parameters

channelId

string

Returns

`/channels/${string}/users/@me/threads/archived/private`

channelMessage()

channelMessage: (channelId, messageId) => `/channels/${string}/messages/${string}`

• GET
• PATCH
• DELETE

Parameters

channelId

string

messageId

string

Returns

`/channels/${string}/messages/${string}`

channelMessageAllReactions()

channelMessageAllReactions: (channelId, messageId) => `/channels/${string}/messages/${string}/reactions`

• DELETE

Parameters

channelId

string

messageId

string

Returns

`/channels/${string}/messages/${string}/reactions`

channelMessageCrosspost()

channelMessageCrosspost: (channelId, messageId) => `/channels/${string}/messages/${string}/crosspost`

• POST

Parameters

channelId

string

messageId

string

Returns

`/channels/${string}/messages/${string}/crosspost`

channelMessageOwnReaction()

channelMessageOwnReaction: (channelId, messageId, emoji) => `/channels/${string}/messages/${string}/reactions/${string}/@me`

• PUT
• DELETE

Parameters

channelId

string

messageId

string

emoji

string

Returns

`/channels/${string}/messages/${string}/reactions/${string}/@me`

channelMessageReaction()

channelMessageReaction: (channelId, messageId, emoji) => `/channels/${string}/messages/${string}/reactions/${string}`

• GET
• DELETE

Parameters

channelId

string

messageId

string

emoji

string

Returns

`/channels/${string}/messages/${string}/reactions/${string}`

channelMessages()

channelMessages: (channelId) => `/channels/${string}/messages`

• GET
• POST

Parameters

channelId

string

Returns

`/channels/${string}/messages`

channelMessagesPin()

channelMessagesPin: (channelId, messageId) => `/channels/${string}/messages/pins/${string}`

• PUT
• DELETE

Parameters

channelId

string

messageId

string

Returns

`/channels/${string}/messages/pins/${string}`

channelMessagesPins()

channelMessagesPins: (channelId) => `/channels/${string}/messages/pins`

• GET

Parameters

channelId

string

Returns

`/channels/${string}/messages/pins`

channelMessageUserReaction()

channelMessageUserReaction: (channelId, messageId, emoji, userId) => `/channels/${string}/messages/${string}/reactions/${string}/${string}`

• DELETE

Parameters

channelId

string

messageId

string

emoji

string

userId

string

Returns

`/channels/${string}/messages/${string}/reactions/${string}/${string}`

channelPermission()

channelPermission: (channelId, overwriteId) => `/channels/${string}/permissions/${string}`

• PUT
• DELETE

Parameters

channelId

string

overwriteId

string

Returns

`/channels/${string}/permissions/${string}`

channelPin()

channelPin: (channelId, messageId) => `/channels/${string}/pins/${string}`

• PUT
• DELETE

Parameters

channelId

string

messageId

string

Returns

`/channels/${string}/pins/${string}`

channelPins()

channelPins: (channelId) => `/channels/${string}/pins`

• GET

Parameters

channelId

string

Returns

`/channels/${string}/pins`

channelRecipient()

channelRecipient: (channelId, userId) => `/channels/${string}/recipients/${string}`

• PUT
• DELETE

Parameters

channelId

string

userId

string

Returns

`/channels/${string}/recipients/${string}`

channelThreads()

channelThreads: (channelId, archivedStatus) => `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public`

• GET
• POST

Parameters

channelId

string

archivedStatus

"private" | "public"

Returns

`/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public`

channelTyping()

channelTyping: (channelId) => `/channels/${string}/typing`

• POST

Parameters

channelId

string

Returns

`/channels/${string}/typing`

channelWebhooks()

channelWebhooks: (channelId) => `/channels/${string}/webhooks`

• GET
• POST

Parameters

channelId

string

Returns

`/channels/${string}/webhooks`

consumeEntitlement()

consumeEntitlement: (applicationId, entitlementId) => `/applications/${string}/entitlements/${string}/consume`

• POST

Parameters

applicationId

string

entitlementId

string

Returns

`/applications/${string}/entitlements/${string}/consume`

currentApplication()

currentApplication: () => "/applications/@me"

• GET

Returns

"/applications/@me"

entitlement()

entitlement: (applicationId, entitlementId) => `/applications/${string}/entitlements/${string}`

• GET
• DELETE

Parameters

applicationId

string

entitlementId

string

Returns

`/applications/${string}/entitlements/${string}`

entitlements()

entitlements: (applicationId) => `/applications/${string}/entitlements`

• GET
• POST

Parameters

applicationId

string

Returns

`/applications/${string}/entitlements`

expirePoll()

expirePoll: (channelId, messageId) => `/channels/${string}/polls/${string}/expire`

• POST

Parameters

channelId

string

messageId

string

Returns

`/channels/${string}/polls/${string}/expire`

gateway()

gateway: () => "/gateway"

• GET

Returns

"/gateway"

gatewayBot()

gatewayBot: () => "/gateway/bot"

• GET

Returns

"/gateway/bot"

guild()

guild: (guildId) => `/guilds/${string}`

• POST

Parameters

guildId

string

Returns

`/guilds/${string}`

guildActiveThreads()

guildActiveThreads: (guildId) => `/guilds/${string}/threads/active`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/threads/active`

guildApplicationCommandsPermissions()

guildApplicationCommandsPermissions: (applicationId, guildId) => `/applications/${string}/guilds/${string}/commands/permissions`

• GET
• PATCH
• DELETE

Parameters

applicationId

string

guildId

string

Returns

`/applications/${string}/guilds/${string}/commands/permissions`

guildAuditLog()

guildAuditLog: (guildId) => `/guilds/${string}/audit-logs`

• GET
• PUT
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/audit-logs`

guildAutoModerationRule()

guildAutoModerationRule: (guildId, ruleId) => `/guilds/${string}/auto-moderation/rules/${string}`

• GET
• PUT
• POST

Parameters

guildId

string

ruleId

string

Returns

`/guilds/${string}/auto-moderation/rules/${string}`

guildAutoModerationRules()

guildAutoModerationRules: (guildId) => `/guilds/${string}/auto-moderation/rules`

• GET
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/auto-moderation/rules`

guildBan()

guildBan: (guildId, userId) => `/guilds/${string}/bans/${string}`

• GET
• PUT
• DELETE

Parameters

guildId

string

userId

string

Returns

`/guilds/${string}/bans/${string}`

guildBans()

guildBans: (guildId) => `/guilds/${string}/bans`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/bans`

guildBulkBan()

guildBulkBan: (guildId) => `/guilds/${string}/bulk-ban`

• POST

Parameters

guildId

string

Returns

`/guilds/${string}/bulk-ban`

guildChannels()

guildChannels: (guildId) => `/guilds/${string}/channels`

• GET
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/channels`

guildCurrentMemberNickname()

guildCurrentMemberNickname: (guildId) => `/guilds/${string}/members/@me/nick`

• PATCH

Parameters

guildId

string

Returns

`/guilds/${string}/members/@me/nick`

guildEmoji()

guildEmoji: (guildId, emojiId) => `/guilds/${string}/emojis/${string}`

• GET
• PATCH

Parameters

guildId

string

emojiId

string

Returns

`/guilds/${string}/emojis/${string}`

guildEmojis()

guildEmojis: (guildId) => `/guilds/${string}/emojis`

• GET
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/emojis`

guildIncidentActions()

guildIncidentActions: (guildId) => `/guilds/${string}/incident-actions`

• DELETE

Parameters

guildId

string

Returns

`/guilds/${string}/incident-actions`

guildIntegration()

guildIntegration: (guildId, integrationId) => `/guilds/${string}/integrations/${string}`

• DELETE

Parameters

guildId

string

integrationId

string

Returns

`/guilds/${string}/integrations/${string}`

guildIntegrations()

guildIntegrations: (guildId) => `/guilds/${string}/integrations`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/integrations`

guildInvites()

guildInvites: (guildId) => `/guilds/${string}/invites`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/invites`

guildMember()

guildMember: (guildId, userId) => `/guilds/${string}/members/${string}`

• GET
• PUT

Parameters

guildId

string

userId?

string = "@me"

Returns

`/guilds/${string}/members/${string}`

guildMemberRole()

guildMemberRole: (guildId, memberId, roleId) => `/guilds/${string}/members/${string}/roles/${string}`

• PUT
• DELETE

Parameters

guildId

string

memberId

string

roleId

string

Returns

`/guilds/${string}/members/${string}/roles/${string}`

guildMembers()

guildMembers: (guildId) => `/guilds/${string}/members`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/members`

guildMembersSearch()

guildMembersSearch: (guildId) => `/guilds/${string}/members/search`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/members/search`

guildMemberVerification()

guildMemberVerification: (guildId) => `/guilds/${string}/member-verification`

• GET
• PATCH

Parameters

guildId

string

Returns

`/guilds/${string}/member-verification`

guildMFA()

guildMFA: (guildId) => `/guilds/${string}/mfa`

• POST

Parameters

guildId

string

Returns

`/guilds/${string}/mfa`

guildOnboarding()

guildOnboarding: (guildId) => `/guilds/${string}/onboarding`

• GET
• PUT

Parameters

guildId

string

Returns

`/guilds/${string}/onboarding`

guildPreview()

guildPreview: (guildId) => `/guilds/${string}/preview`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/preview`

guildPrune()

guildPrune: (guildId) => `/guilds/${string}/prune`

• GET
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/prune`

guildRole()

guildRole: (guildId, roleId) => `/guilds/${string}/roles/${string}`

• GET
• PATCH
• DELETE

Parameters

guildId

string

roleId

string

Returns

`/guilds/${string}/roles/${string}`

guildRoleMemberCounts()

guildRoleMemberCounts: (guildId) => `/guilds/${string}/roles/member-counts`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/roles/member-counts`

guildRoles()

guildRoles: (guildId) => `/guilds/${string}/roles`

• GET
• POST
• PATCH

Parameters

guildId

string

Returns

`/guilds/${string}/roles`

guilds()

guilds: () => "/guilds"

• GET
• POST

Returns

"/guilds"

guildScheduledEvent()

guildScheduledEvent: (guildId, guildScheduledEventId) => `/guilds/${string}/scheduled-events/${string}`

• GET
• PATCH
• DELETE

Parameters

guildId

string

guildScheduledEventId

string

Returns

`/guilds/${string}/scheduled-events/${string}`

guildScheduledEvents()

guildScheduledEvents: (guildId) => `/guilds/${string}/scheduled-events`

• GET
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/scheduled-events`

guildScheduledEventUsers()

guildScheduledEventUsers: (guildId, guildScheduledEventId) => `/guilds/${string}/scheduled-events/${string}/users`

• GET

Parameters

guildId

string

guildScheduledEventId

string

Returns

`/guilds/${string}/scheduled-events/${string}/users`

guildSoundboardSound()

guildSoundboardSound: (guildId, soundId) => `/guilds/${string}/soundboard-sounds/${string}`

• GET
• PATCH
• DELETE

Parameters

guildId

string

soundId

string

Returns

`/guilds/${string}/soundboard-sounds/${string}`

guildSoundboardSounds()

guildSoundboardSounds: (guildId) => `/guilds/${string}/soundboard-sounds`

• GET
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/soundboard-sounds`

guildSticker()

guildSticker: (guildId, stickerId) => `/guilds/${string}/stickers/${string}`

• GET
• PATCH
• DELETE

Parameters

guildId

string

stickerId

string

Returns

`/guilds/${string}/stickers/${string}`

guildStickers()

guildStickers: (guildId) => `/guilds/${string}/stickers`

• GET
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/stickers`

guildTemplate()

guildTemplate: (guildId, code) => `/guilds/${string}/templates/${string}`

• PUT
• PATCH
• DELETE

Parameters

guildId

string

code

string

Returns

`/guilds/${string}/templates/${string}`

guildTemplates()

guildTemplates: (guildId) => `/guilds/${string}/templates`

• GET
• POST

Parameters

guildId

string

Returns

`/guilds/${string}/templates`

guildVanityUrl()

guildVanityUrl: (guildId) => `/guilds/${string}/vanity-url`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/vanity-url`

guildVoiceRegions()

guildVoiceRegions: (guildId) => `/guilds/${string}/regions`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/regions`

guildVoiceState()

guildVoiceState: (guildId, userId) => `/guilds/${string}/voice-states/${string}`

• GET
• PATCH

Parameters

guildId

string

userId?

string = "@me"

Returns

`/guilds/${string}/voice-states/${string}`

guildWebhooks()

guildWebhooks: (guildId) => `/guilds/${string}/webhooks`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/webhooks`

guildWelcomeScreen()

guildWelcomeScreen: (guildId) => `/guilds/${string}/welcome-screen`

• GET
• PATCH

Parameters

guildId

string

Returns

`/guilds/${string}/welcome-screen`

guildWidgetImage()

guildWidgetImage: (guildId) => `/guilds/${string}/widget.png`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/widget.png`

guildWidgetJSON()

guildWidgetJSON: (guildId) => `/guilds/${string}/widget.json`

• GET

Parameters

guildId

string

Returns

`/guilds/${string}/widget.json`

guildWidgetSettings()

guildWidgetSettings: (guildId) => `/guilds/${string}/widget`

• GET
• PATCH

Parameters

guildId

string

Returns

`/guilds/${string}/widget`

interactionCallback()

interactionCallback: (interactionId, interactionToken) => `/interactions/${string}/${string}/callback`

• GET
• DELETE

Parameters

interactionId

string

interactionToken

string

Returns

`/interactions/${string}/${string}/callback`

invite()

invite: (code) => `/invites/${string}`

• GET
• POST

Parameters

code

string

Returns

`/invites/${string}`

nitroStickerPacks()

nitroStickerPacks: () => "/sticker-packs"

• GET
• POST

Returns

"/sticker-packs"

oauth2Authorization()

oauth2Authorization: () => "/oauth2/authorize"

• GET
• POST

Returns

"/oauth2/authorize"

oauth2CurrentApplication()

oauth2CurrentApplication: () => "/oauth2/applications/@me"

• GET

Returns

"/oauth2/applications/@me"

oauth2CurrentAuthorization()

oauth2CurrentAuthorization: () => "/oauth2/@me"

• GET

Returns

"/oauth2/@me"

oauth2TokenExchange()

oauth2TokenExchange: () => "/oauth2/token"

• POST

Returns

"/oauth2/token"

oauth2TokenRevocation()

oauth2TokenRevocation: () => "/oauth2/token/revoke"

• POST

Returns

"/oauth2/token/revoke"

pollAnswerVoters()

pollAnswerVoters: (channelId, messageId, answerId) => `/channels/${string}/polls/${string}/answers/${number}`

• GET
• POST

Parameters

channelId

string

messageId

string

answerId

number

Returns

`/channels/${string}/polls/${string}/answers/${number}`

sendSoundboardSound()

sendSoundboardSound: (channelId) => `/channels/${string}/send-soundboard-sound`

• POST

Parameters

channelId

string

Returns

`/channels/${string}/send-soundboard-sound`

skus()

skus: (applicationId) => `/applications/${string}/skus`

• GET

Parameters

applicationId

string

Returns

`/applications/${string}/skus`

skuSubscription()

skuSubscription: (skuId, subscriptionId) => `/skus/${string}/subscriptions/${string}`

• GET

Parameters

skuId

string

subscriptionId

string

Returns

`/skus/${string}/subscriptions/${string}`

skuSubscriptions()

skuSubscriptions: (skuId) => `/skus/${string}/subscriptions`

• GET

Parameters

skuId

string

Returns

`/skus/${string}/subscriptions`

soundboardDefaultSounds()

soundboardDefaultSounds: () => "/soundboard-default-sounds"

• GET

Returns

"/soundboard-default-sounds"

stageInstance()

stageInstance: (channelId) => `/stage-instances/${string}`

• GET
• POST

Parameters

channelId

string

Returns

`/stage-instances/${string}`

stageInstances()

stageInstances: () => "/stage-instances"

• GET
• POST

Returns

"/stage-instances"

sticker()

sticker: (stickerId) => `/stickers/${string}`

• GET

Parameters

stickerId

string

Returns

`/stickers/${string}`

stickerPack()

stickerPack: (packId) => `/sticker-packs/${string}`

• GET

Parameters

packId

string

Returns

`/sticker-packs/${string}`

stickerPacks()

stickerPacks: () => "/sticker-packs"

• GET
• POST

Returns

"/sticker-packs"

template()

template: (code) => `/guilds/templates/${string}`

• GET
• PUT
• DELETE

Parameters

code

string

Returns

`/guilds/templates/${string}`

threadMembers()

threadMembers: (threadId, userId?) => `/channels/${string}/thread-members/${string}` | `/channels/${string}/thread-members`

• GET
• PUT
• DELETE

Parameters

threadId

string

userId?

string

Returns

`/channels/${string}/thread-members/${string}` | `/channels/${string}/thread-members`

threads()

threads: (parentId, messageId?) => `/channels/${string}/threads`

• POST

Parameters

parentId

string

messageId?

string

Returns

`/channels/${string}/threads`

user()

user: (userId) => `/users/${string}`

• GET
• PUT

Parameters

userId?

string = "@me"

Returns

`/users/${string}`

userApplicationRoleConnection()

userApplicationRoleConnection: (applicationId) => `/users/@me/applications/${string}/role-connection`

• GET
• PUT

Parameters

applicationId

string

Returns

`/users/@me/applications/${string}/role-connection`

userChannels()

userChannels: () => "/users/@me/channels"

• POST

Returns

"/users/@me/channels"

userConnections()

userConnections: () => "/users/@me/connections"

• GET

Returns

"/users/@me/connections"

userGuild()

userGuild: (guildId) => `/users/@me/guilds/${string}`

• DELETE

Parameters

guildId

string

Returns

`/users/@me/guilds/${string}`

userGuildMember()

userGuildMember: (guildId) => `/users/@me/guilds/${string}/member`

• GET

Parameters

guildId

string

Returns

`/users/@me/guilds/${string}/member`

userGuilds()

userGuilds: () => "/users/@me/guilds"

• GET

Returns

"/users/@me/guilds"

voiceRegions()

voiceRegions: () => "/voice/regions"

• GET

Returns

"/voice/regions"

webhook()

webhook: (webhookId, webhookToken?) => `/webhooks/${string}`

• GET
• PATCH
• DELETE
• POST

Parameters

webhookId

string

webhookToken?

string

Returns

`/webhooks/${string}`

webhookMessage()

webhookMessage: (webhookId, webhookToken, messageId?) => `/webhooks/${string}/${string}/messages/${string}`

• GET
• PATCH
• DELETE

Parameters

webhookId

string

webhookToken

string

messageId?

string

Returns

`/webhooks/${string}/${string}/messages/${string}`

webhookPlatform()

webhookPlatform: (webhookId, webhookToken, platform) => `/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`

• POST

Parameters

webhookId

string

webhookToken

string

platform

"github" | "slack"

Returns

`/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`