Parameters
1 query
Query parameters
· 1idstringRequired24-char room id.
Length: 24–24
Example
example_id1 query
idstringRequired24-char room id.
example_id1 status code documented
state"ok"RequiredroomobjectRequiredidstringRequiredthemestring | nullRequiredColour theme key (see room-update), null = brand colour.
draftobject | nullRequiredtextstringRequiredmentionsobject[]RequiredidstringRequirednamestringRequiredsavedAtstringRequiredtype"self" | "direct" | "group"RequiredtitlestringRequiredparticipantsobject[]RequireduserIdstringRequiredfullNamestringRequiredrole"owner" | "member"RequiredlastReadPositionstring | integerRequired0lastReadDatestring | nullRequiredlastPositionstring | integerRequired0lastMessageobject | nullRequiredidstringRequiredpositionstring | integerRequired0kind"member" | "system"RequiredauthorUserIdstring | nullRequiredpreviewstringRequiredsystemobject | nullRequiredeventstringRequiredactorUserIdstringRequiredtitlestringOptionaluserIdstringOptionaluserIdsstring[]Optionalpositionstring | integerOptional0roomIdstringOptionalreminder: room of the message.
previewstringOptionalauthorUserIdstring | nullOptionalissueKeystringOptionalissue-created: the new task.
organisationNamestringOptionalcallIdstringOptionalvideobooleanOptionaloutcome"completed" | "missed" | "declined"OptionaldurationSecstring | integerOptional0attachmentCountstring | integerRequired0insertedDatestringRequiredlastMessageDatestring | nullRequiredblockedByMebooleanRequiredDirect room: I blocked the other person.
isBlockedbooleanRequiredDirect room: a block exists in either direction; sending is disabled.
myLastReadPositionstring | integerRequired0unreadCountstring | integerRequired0myRole"owner" | "member"RequiredisMutedbooleanRequiredisPinnedbooleanRequiredinsertedDatestringRequireddepartmentChannelobject | nullRequiredDepartment channel: membership follows the structure.
organisationNamestringRequiredstate"not-found"Required{
"state": "ok",
"room": {
"id": "example_id",
"title": "example_title",
"participants": [
{
"userId": "example_userId",
"fullName": "example_fullName"
}
],
"blockedByMe": false,
"isBlocked": false,
"isMuted": false,
"isPinned": false,
"insertedDate": "example_insertedDate"
}
}GET /bff/team-chat/room
curl -X GET "https://api.bizkithub.com/bff/team-chat/room?id=example_id" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"All BizKitHub public API endpoints require authentication via API key.