Skip to main content

Chatroom

PropertyTypeDescriptionOptional
memberMemberThe member associated with the chatroom.
idnumberUnique identifier for the chatroom.
titlestringThe title or name of the chatroom.
createdAtnumberTimestamp when the chatroom was created.
answerTextstringText of an answer related to the chatroom (if applicable).
statenumberCurrent state of the chatroom.
unseenCountnumberNumber of unseen messages in the chatroom.
shareUrlstringURL for sharing the chatroom.
communityIdstringIdentifier for the associated community.
communityNamestringName of the associated community.
typenumberType of chatroom (e.g., group, DM).
aboutstringDescription of the chatroom.
headerstringHeader text for the chatroom.
showFollowTelescopebooleanIndicates if the follow telescope feature is enabled.
showFollowAutoTagbooleanIndicates if the auto-tagging follow feature is enabled.
cardCreationTimestringTimestamp when the chatroom card was created.
participantsCountstringTotal number of participants in the chatroom.
totalResponseCountstringTotal number of responses in the chatroom.
muteStatusbooleanWhether the chatroom is muted.
followStatusbooleanWhether the user follows the chatroom.
hasBeenNamedbooleanWhether the chatroom has been given a custom name.
hasReactionsbooleanWhether reactions are enabled in the chatroom.
datestringDate associated with the chatroom.
isTaggedbooleanWhether the chatroom is tagged.
isPendingbooleanWhether the chatroom is pending approval.
isPrivateMemberbooleanWhether the chatroom is private for the user.
isPinnedbooleanWhether the chatroom is pinned.
isDeletedbooleanWhether the chatroom has been deleted.
userIdstringUser ID associated with the chatroom.
deletedBystringUser who deleted the chatroom (if applicable).
deletedByMemberMemberMember who deleted the chatroom (if applicable).
deletedByUserIdstringID of the user who deleted the chatroom.
updatedAtnumberTimestamp when the chatroom was last updated.
lastSeenConversationIdstringID of the last seen conversation in the chatroom.
lastConversationIdstringID of the last conversation in the chatroom.
dateEpochnumberEpoch timestamp for the chatroom date.
isSecretbooleanWhether the chatroom is secret.
secretChatroomParticipantsnumber[]List of user IDs participating in a secret chatroom.
secretChatroomLeftbooleanWhether the user has left the secret chatroom.
topicIdstringID of the associated topic.
topicConversationThe topic associated with the chatroom.
autoFollowDonebooleanWhether auto-following has been completed.
isEditedbooleanWhether the chatroom details have been edited.
accessnumberAccess level of the chatroom.
memberCanMessagebooleanWhether a member can send messages in the chatroom.
chatroomWithUserIdnumberID of the user in a one-on-one chatroom.
chatroomWithUserNamestringName of the user in a one-on-one chatroom.
chatroomWithUserMemberMember object representing the user in a one-on-one chatroom.
externalSeenbooleanWhether the chatroom was seen externally.
unreadConversationCountnumberCount of unread conversations.
chatroomImageUrlstringURL of the chatroom image.
accessWithoutSubscriptionbooleanWhether access is allowed without a subscription.
totalAllResponseCountstringTotal response count across all messages.
isConversationStoredbooleanWhether the conversation is stored.
chatRequestStatenumberState of the chat request.
chatRequestedByMemberMember who requested the chat.
chatRequestCreatedAtnumberTimestamp when the chat request was created.
chatRequestedByIdnumberID of the user who requested the chat.

ChatroomDetails

PropertyTypeDescriptionOptional
canAccessSecretChatroomboolean | undefinedIndicates if the user can access the secret chatroom.
chatroomChatroomThe chatroom details.
chatroomActionsChatroomAction[]List of available actions in the chatroom.
communityCommunityThe community associated with the chatroom.
conversationUsersConversationUser[]List of users in the conversation.
lastConversationIdnumberID of the last conversation in the chatroom.
participantCountnumberNumber of participants in the chatroom.
unreadMessagesnumberNumber of unread messages in the chatroom.

ChatroomAction

PropertyTypeDescriptionOptional
idnumberUnique identifier for the action.
titlestringTitle of the chatroom action.

ConversationUser

PropertyTypeDescriptionOptional
idnumberUnique identifier for the user.
image_urlstringURL of the user's profile image.
namestringName of the user.