Skip to content

API Reference

Top

FieldTypeLabelDescription
invite_idstring

FieldTypeLabelDescription
tokenstring
host_server_urlstring
guild_idstring

FieldTypeLabelDescription
event_iduint64

FieldTypeLabelDescription
server_urlstring

FieldTypeLabelDescription
guild_idstring
user_idstring
role_idstring

FieldTypeLabelDescription
origin_server_idstring
banned_user_pubkeystring
guild_idstring
reasonstring
evidence_hashstring
timestampuint64
signaturebytes

FieldTypeLabelDescription
guild_idstring
user_idstring
reasonstring

FieldTypeLabelDescription
guild_idstring
rolesRolerepeated

FieldTypeLabelDescription
idstring
guild_idstring
folder_idstring
namestring
positionint32
latest_message_idstring
irc_namestring
is_threadbool
parent_channel_idstring
root_message_idstring

FieldTypeLabelDescription
typeComponentType
componentsComponentrepeatedFor Action Row
styleint32For Button

1=Primary, 2=Secondary, 3=Success, 4=Danger, 5=Link | | label | string | | | | emoji | string | | | | custom_id | string | | | | url | string | | | | disabled | bool | | | | options | SelectOption | repeated | For Select | | placeholder | string | | | | min_values | int32 | | | | max_values | int32 | | |

FieldTypeLabelDescription
guild_idstring
folder_idstring
namestring
irc_namestringoptional

FieldTypeLabelDescription
target_user_idstring

FieldTypeLabelDescription
guildGuild
tokenstring

FieldTypeLabelDescription
guild_idstring
parent_folder_idstring
namestring

FieldTypeLabelDescription
namestring
avatar_urlstringoptional

FieldTypeLabelDescription
guildGuild
tokenstring

FieldTypeLabelDescription
guild_idstring
namestring
colorstring
positionint32
permissionsstringrepeated
parent_role_idsstringrepeated

FieldTypeLabelDescription
parent_channel_idstring
root_message_idstring
namestring

FieldTypeLabelDescription
channel_idstring
namestring
avatar_urlstringoptional

FieldTypeLabelDescription
tokenstring
invite_idstringUnique ID for the invite record (uuid)
inviter_idstring
guild_idstring
guild_namestring
host_server_urlstring
timestampuint64
signaturebytesInviter signature over (token
statusstring”pending”, “accepted”, “rejected”
inviter_pubkeystring
device_certDeviceCert
target_user_idstring

FieldTypeLabelDescription
guild_idstring
tokenstring

FieldTypeLabelDescription
channel_idstring
message_idstring

FieldTypeLabelDescription
guild_idstring
role_idstring

FieldTypeLabelDescription
webhook_idstring

FieldTypeLabelDescription
message_idstring
channel_idstring
user_idstring
statusReceiptType
timestampgoogle.protobuf.Timestamp

FieldTypeLabelDescription
pubkeystring
device_idstring
issued_atuint64
expiryuint64
signaturestringSigned by K_id

FieldTypeLabelDescription
idstring
namestring
last_seen_atuint64

FieldTypeLabelDescription
origin_server_idstring
origin_server_pubkeystring
user_pubkeystring
user_display_namestring
guild_idstring
timestampuint64
signaturebytes

FieldTypeLabelDescription
acceptedbool
messagestring
userUser

FieldTypeLabelDescription
idstring
guild_idstring
parent_folder_idstring
namestring
positionint32

FieldTypeLabelDescription
channel_idstring

FieldTypeLabelDescription
tokenstring

FieldTypeLabelDescription
channel_idstring

FieldTypeLabelDescription
tokenstring
urlstring

FieldTypeLabelDescription
guild_idstring
user_idstring

FieldTypeLabelDescription
channel_idstring
cursorstring
limitint32
reversebool

FieldTypeLabelDescription
messagesMessagerepeated
next_cursorstring
has_morebool

FieldTypeLabelDescription
userUser
serversUserServerrepeated
device_certificatesDeviceInforepeated
push_distributorsstringrepeated

FieldTypeLabelDescription
guild_idstring

FieldTypeLabelDescription
permissionsstringrepeated

FieldTypeLabelDescription
channel_idstring

FieldTypeLabelDescription
messagesMessagerepeated

FieldTypeLabelDescription
user_idsstringrepeated

FieldTypeLabelDescription
presencePresenceUpdaterepeated

FieldTypeLabelDescription
user_idsstringrepeated
guild_idstring

FieldTypeLabelDescription
usersUserrepeated

FieldTypeLabelDescription
idstring
namestring
owner_idstring
avatar_urlstring
latest_message_idstring
is_dmbool

FieldTypeLabelDescription
guild_idstring
userUser

FieldTypeLabelDescription
summaryGuildMemberSummary
message_countint32
recent_messagesMessagerepeated

FieldTypeLabelDescription
guild_idstring
user_idstring

FieldTypeLabelDescription
userUser
joined_atgoogle.protobuf.Timestamp
rolesstringrepeatedList of role IDs

FieldTypeLabelDescription
messagestring

FieldTypeLabelDescription
upload_tokenstring

FieldTypeLabelDescription
tokenstring
channel_idstring
created_atgoogle.protobuf.Timestamp
expires_atgoogle.protobuf.Timestamp
usesint32
channel_namestring
is_deactivatedbool
updated_atgoogle.protobuf.Timestamp

FieldTypeLabelDescription
tokenstring
public_keystringK_id pubkey
device_certDeviceCert
signaturebytesSigned by K_dev
timestampuint64
display_namestring
avatar_urlstring
homeserver_urlstring

FieldTypeLabelDescription
guildGuild
tokenstring
refresh_tokenstring

FieldTypeLabelDescription
guild_idstring
user_idstring
reasonstring

FieldTypeLabelDescription
guild_idstring

FieldTypeLabelDescription
channelsChannelrepeated

FieldTypeLabelDescription
invitesDMInviterepeated

FieldTypeLabelDescription
guild_idstring

FieldTypeLabelDescription
foldersFolderrepeated

FieldTypeLabelDescription
guild_idstring
limitint32
offsetint32

FieldTypeLabelDescription
membersGuildMemberSummaryrepeated
totalint32

FieldTypeLabelDescription
guildsGuildrepeated

FieldTypeLabelDescription
guild_idstring

FieldTypeLabelDescription
invitesInviterepeated

FieldTypeLabelDescription
distributor_urlsstringrepeated

FieldTypeLabelDescription
guild_idstring

FieldTypeLabelDescription
rolesRolerepeated

FieldTypeLabelDescription
limitint32
offsetint32

FieldTypeLabelDescription
guildsServerGuildStatsrepeated
totalint32

FieldTypeLabelDescription
guild_idstring
channel_idstringoptional

FieldTypeLabelDescription
webhooksWebhookrepeated

FieldTypeLabelDescription
device_certDeviceCert
signaturebytesSigned by K_dev
timestampuint64
device_namestringoptional
new_homeserverstringoptionalMigration fields
migration_timestampuint64optional
migration_signaturestringoptionalSigned by K_id over (new_homeserver
migration_targetsstringrepeated
user_idstringoptional

FieldTypeLabelDescription
tokenstring
userUser
refresh_tokenstring

FieldTypeLabelDescription
file_idstring
mime_typestring
size_bytesuint64
blurhashstring
widthuint32
heightuint32

FieldTypeLabelDescription
idstring
channel_idstring
sender_idstring
created_atgoogle.protobuf.Timestamp
edited_atgoogle.protobuf.Timestamp
reply_to_message_idstring
textstring
mediaMediaAttachment
actionSystemAction
typingTypingIndicator
reactionReactionIndicator
reactionsReactionrepeated
metadataMessage.MetadataEntryrepeated
is_pinnedbool
sender_namestring
mentioned_user_idsstringrepeated
mentioned_role_idsstringrepeated
sender_avatar_urlstring
componentsComponentrepeated
thread_idstring

FieldTypeLabelDescription
keystring
valuestring

FieldTypeLabelDescription
channel_idstring
message_idstring

FieldTypeLabelDescription
messageMessage
idempotency_keystring

FieldTypeLabelDescription
channel_idstring
message_idstring

FieldTypeLabelDescription
timestampuint64

FieldTypeLabelDescription
timestampuint64

FieldTypeLabelDescription
user_idstring
statusPresenceStatus
last_seengoogle.protobuf.Timestamp
active_call_channel_idstring

FieldTypeLabelDescription
tokenstring

FieldTypeLabelDescription
channel_idstring
channel_namestring
guild_idstring
guild_namestring
member_countint32
guild_avatar_urlstringoptional

FieldTypeLabelDescription
queriesServerQueryrepeated

FieldTypeLabelDescription
serverstring
guildsGuildrepeated
channelsChannelrepeated
errorstringoptional

FieldTypeLabelDescription
target_user_idstring
push_delegation_tokenstring
payloadstringJSON payload

FieldTypeLabelDescription
emojistring
user_idsstringrepeated

FieldTypeLabelDescription
message_idstring
emojistring
typeReactionType

FieldTypeLabelDescription
target_message_idstring
emojistring
addedbool

FieldTypeLabelDescription
channel_idstring
message_idstring
emojistring

FieldTypeLabelDescription
inviteDMInvite

FieldTypeLabelDescription
refresh_tokenstring

FieldTypeLabelDescription
tokenstring
refresh_tokenstring
userUser

FieldTypeLabelDescription
tokenstring

FieldTypeLabelDescription
distributor_urlstring

FieldTypeLabelDescription
display_namestring
public_keystringK_id pubkey
device_certDeviceCert
id_proofstringSignature of public_key by K_id to prove ownership
device_namestringoptional
signaturebytesSigned by K_dev (over timestamp)
timestampuint64

FieldTypeLabelDescription
tokenstring
userUser
refresh_tokenstring

FieldTypeLabelDescription
invite_idstring

FieldTypeLabelDescription
server_urlstring

FieldTypeLabelDescription
idstring
guild_idstring
namestring
colorstring
positionint32
permissionsstringrepeated
parent_role_idsstringrepeated

FieldTypeLabelDescription
channel_idstring
querystring
limituint32
offsetuint32

FieldTypeLabelDescription
messagesMessagerepeated
totaluint32

FieldTypeLabelDescription
reachablebool
messagestring
index_countuint32
database_sizeuint64
last_update_unix_msuint64
indexed_documentsuint64
is_indexingbool

FieldTypeLabelDescription
labelstring
valuestring
descriptionstring
is_defaultbool
emojistring

FieldTypeLabelDescription
target_user_idstring
inviteDMInvite

FieldTypeLabelDescription
channel_idstring
idempotency_keystring
textstring
typingTypingContent
reactionReactionContent
componentsComponentrepeated

FieldTypeLabelDescription
messageMessage

FieldTypeLabelDescription
guildGuild
member_countint32
channel_countint32
message_countint32

FieldTypeLabelDescription
canonical_addressstring
livekit_configuredbool
irc_enabledbool
irc_portint32
irc_serverstring

FieldTypeLabelDescription
urlstring
tokenstring

FieldTypeLabelDescription
max_upload_sizeuint32
message_rate_limituint32
max_message_lengthuint32
register_rate_limituint32
login_rate_limituint32
invite_rate_limituint32
discovery_rate_limituint32
sync_mailbox_rate_limituint32
ping_rate_limituint32

FieldTypeLabelDescription
event_iduint64
timestampgoogle.protobuf.Timestamp
message_createdMessageEvent
message_updatedMessageEvent
deliveryDeliveryReceipt
presencePresenceUpdate
member_joinedGuildMemberJoined
user_updatedUserUpdated
message_deletedMessageDeletedEvent
member_removedGuildMemberRemoved

FieldTypeLabelDescription
resume_from_event_idstring

FieldTypeLabelDescription
session_idstring
payloadbytesoptionalJSON or encrypted data
wait_for_databoolIf true, long-poll until data is available

FieldTypeLabelDescription
payloadbytesoptional

FieldTypeLabelDescription
is_typingbool

FieldTypeLabelDescription
channel_idstring
is_typingbool
user_idstring

FieldTypeLabelDescription
guild_idstring
user_idstring
role_idstring

FieldTypeLabelDescription
channel_idstring
message_idstring

FieldTypeLabelDescription
tokenstring

FieldTypeLabelDescription
channel_idstring
namestringoptional
folder_idstringoptional
irc_namestringoptional
positionint32optional

FieldTypeLabelDescription
user_idstring
display_namestring
avatar_urlstring
biostring
device_certDeviceCert
timestampuint64
signaturebytesThe same signature provided by the client in UpdateUserRequest

FieldTypeLabelDescription
guild_idstring
namestringoptional
avatar_urlstringoptional

FieldTypeLabelDescription
user_idstring
new_homeserverstring
timestampuint64
signaturestringSigned by K_id

FieldTypeLabelDescription
statusPresenceStatus
active_call_channel_idstring

FieldTypeLabelDescription
role_idstring
guild_idstringFor verification
namestring
colorstring
positionint32
permissionsstringrepeated
parent_role_idsstringrepeated

FieldTypeLabelDescription
max_upload_sizeuint32optional
message_rate_limituint32optional
max_message_lengthuint32optional
register_rate_limituint32optional
login_rate_limituint32optional
invite_rate_limituint32optional
discovery_rate_limituint32optional
sync_mailbox_rate_limituint32optional
ping_rate_limituint32optional

FieldTypeLabelDescription
namestringoptional
avatar_urlstringoptional
presence_preferencePresenceStatusoptional
biostringoptional
guild_orderstringoptional
is_profile_syncedbooloptional
irc_namestringoptional
device_certDeviceCert
timestampuint64
signaturebytesSignature of request body (excluding signature itself) by K_dev

FieldTypeLabelDescription
webhook_idstring
namestringoptional
avatar_urlstringoptional
channel_idstringoptional

FieldTypeLabelDescription
upload_tokenstring

FieldTypeLabelDescription
upload_tokenstring
filenamestring
mime_typestring
total_sizeuint64
chunk_sizeuint32

FieldTypeLabelDescription
upload_tokenstring
chunk_indexuint32
databytes
sha256string

FieldTypeLabelDescription
upload_tokenstring
sha256string

FieldTypeLabelDescription
file_idstring
public_urlstring
thumb_file_idstringoptional
thumb_public_urlstringoptional

FieldTypeLabelDescription
idstring
namestring
avatar_colorstring
statusstring
ephemeralbool
public_keystringK_dev public key (deprecated/legacy use)
presence_preferencePresenceStatus
is_server_adminbool
avatar_urlstring
biostring
id_pubkeystringK_id pubkey
homeserverstring
is_ircbool
guild_orderstringJSON array of guild IDs
is_profile_syncedbool
irc_namestring

FieldTypeLabelDescription
server_urlstring
created_atuint64

FieldTypeLabelDescription
userUser

FieldTypeLabelDescription
user_idstringK_id pubkey
challengestringSigned challenge by K_id

FieldTypeLabelDescription
userUser
push_delegation_tokenstring

FieldTypeLabelDescription
idstring
channel_idstring
guild_idstring
namestring
avatar_urlstringoptional
tokenstring
creator_idstring

NameNumberDescription
COMPONENT_TYPE_UNSPECIFIED0
COMPONENT_TYPE_ACTION_ROW1
COMPONENT_TYPE_BUTTON2
COMPONENT_TYPE_STRING_SELECT3

NameNumberDescription
PRESENCE_STATUS_UNSPECIFIED0
PRESENCE_STATUS_ONLINE1
PRESENCE_STATUS_OFFLINE3
PRESENCE_STATUS_BUSY4

NameNumberDescription
REACTION_TYPE_ADD0
REACTION_TYPE_REMOVE1

NameNumberDescription
RECEIPT_TYPE_UNSPECIFIED0
RECEIPT_TYPE_DELIVERED1
RECEIPT_TYPE_READ2

Combined Service definition

Method NameRequest TypeResponse TypeDescription
RegisterRegisterRequestRegisterResponseAuth
LoginLoginRequestLoginResponse
RefreshRefreshRequestRefreshResponse
SubscribeEventsSubscribeRequestStreamResponse streamReal-time Events
SendMessageSendMessageRequestSendMessageResponseUnary Actions
AckMessageAcknowledgeRequestEmpty
UpdatePresenceUpdatePresenceRequestEmpty
UpdateUserUpdateUserRequestUser
SignalOnlineEmptyEmpty
SignalOfflineEmptyEmpty
GetPresenceGetPresenceRequestGetPresenceResponse
GenerateInviteGenerateInviteRequestGenerateInviteResponse
PreviewInvitePreviewInviteRequestPreviewInviteResponse
JoinInviteJoinInviteRequestJoinInviteResponse
PingPingRequestPongResponse
CreateGuildCreateGuildRequestCreateGuildResponseHeavy Operations
CreateFolderCreateFolderRequestFolder
CreateChannelCreateChannelRequestChannel
CreateThreadCreateThreadRequestChannel
UpdateChannelUpdateChannelRequestChannel
ListGuildsListGuildsRequestListGuildsResponse
ListFoldersListFoldersRequestListFoldersResponse
ListChannelsListChannelsRequestListChannelsResponse
GetHistoryGetHistoryRequestGetHistoryResponse
UpdateGuildUpdateGuildRequestGuild
ListInvitesListInvitesRequestListInvitesResponse
DeactivateInviteDeactivateInviteRequestEmpty
ListServerGuildsListServerGuildsRequestListServerGuildsResponse
InitiateAvatarUploadInitiateAvatarUploadRequestInitiateUploadResponseChunked Upload API
InitiateMediaUploadInitiateMediaUploadRequestInitiateUploadResponse
UploadBeginUploadBeginRequestEmpty
UploadChunkUploadChunkRequestEmpty
UploadFinishUploadFinishRequestUploadMediaResponse
UploadAbortUploadAbortRequestEmpty
GetUsersGetUsersRequestGetUsersResponse
PinMessagePinMessageRequestEmptyPinning
UnpinMessageUnpinMessageRequestEmpty
GetPinnedMessagesGetPinnedMessagesRequestGetPinnedMessagesResponse
SearchMessagesSearchMessagesRequestSearchMessagesResponse
DeleteMessageDeleteMessageRequestEmpty
FederateFederationRequestFederationResponseFederation
PropagateBanBanNotificationEmpty
CreateRoleCreateRoleRequestRoleRole Management
UpdateRoleUpdateRoleRequestRole
BatchUpdateRolesBatchUpdateRolesRequestEmpty
DeleteRoleDeleteRoleRequestEmpty
ListRolesListRolesRequestListRolesResponse
AssignRoleAssignRoleRequestEmpty
UnassignRoleUnassignRoleRequestEmpty
GetMyPermissionsGetMyPermissionsRequestGetMyPermissionsResponse
KickUserKickUserRequestEmptyModeration
BanUserBanUserRequestEmpty
ListGuildMembersListGuildMembersRequestListGuildMembersResponse
GetGuildMemberProfileGetGuildMemberProfileRequestGuildMemberProfile
RegisterPushDistributorRegisterPushDistributorRequestEmptyPush Notifications
ListPushDistributorsEmptyListPushDistributorsResponse
RegisterFcmTokenRegisterFcmTokenRequestEmpty
UnregisterFcmTokenUnregisterFcmTokenRequestEmpty
GetMyDataEmptyGetMyDataResponseUser Data
AddServerAddServerRequestEmpty
RemoveServerRemoveServerRequestEmpty
HelloGrpcEmptyHelloResponseSanity Check
GetServerInfoEmptyServerInfoResponseServer Info
GetSearchStatusEmptySearchStatusResponse
GetServerSettingsEmptyServerSettings
UpdateServerSettingsUpdateServerSettingsRequestServerSettings
SyncMailboxSyncMailboxRequestSyncMailboxResponseSync/Handshake Mailbox
ProxiedUnreadProxiedUnreadRequestProxiedUnreadResponse streamProxied Unread
GetCallTokenGetCallTokenRequestGetCallTokenResponseCalls
VerifyUserVerifyUserRequestVerifyUserResponseFederation RPCs
PushNotificationPushNotificationRequestEmpty
UpdateHomeServerUpdateHomeServerRequestEmpty
UpdateFederatedProfileUpdateFederatedProfileRequestEmpty
CreateDMCreateDMRequestCreateDMResponseDM / Invite System
SendDMInviteSendDMInviteRequestEmpty
ReceiveDMInviteReceiveDMInviteRequestEmpty
ListDMInvitesListDMInvitesRequestListDMInvitesResponse
AcceptDMInviteAcceptDMInviteRequestAcceptDMInviteResponse
RejectDMInviteRejectDMInviteRequestEmpty
CreateWebhookCreateWebhookRequestWebhookWebhooks
ListWebhooksListWebhooksRequestListWebhooksResponse
UpdateWebhookUpdateWebhookRequestWebhook
DeleteWebhookDeleteWebhookRequestEmpty
.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)