BizKitHub
DocsAPI ReferenceTeam Chat/bff/team-chat/inbox
getTeam ChatAdmin BFF

/bff/team-chat/inbox

Self / direct / group rooms the caller participates in, pinned first, then by latest activity. Each room carries participants with their read watermark, the last message preview and the unread count (lastPosition - myLastReadPosition). totalUnread sums unread counts of non-muted rooms (header badge).

Team chatgetBffTeam-chatInbox

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
themestring | nullRequired
One of 2:
Variant 1
string

Colour theme key (see room-update), null = brand colour.

Variant 2
null
draftobject | nullRequired
One of 2:
Variant 1
textstringRequired
mentionsobject[]Required
Each array item:
idstringRequired
namestringRequired
savedAtstringRequired
Variant 2
null
type"self" | "direct" | "group"Required
titlestringRequired
participantsobject[]Required
Each array item:
userIdstringRequired
fullNamestringRequired
role"owner" | "member"Required
lastReadPositionstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
lastReadDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
lastPositionstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
lastMessageobject | nullRequired
One of 2:
Variant 1
idstringRequired
positionstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
kind"member" | "system"Required
authorUserIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
previewstringRequired
systemobject | nullRequired
One of 2:
Variant 1
eventstringRequired
actorUserIdstringRequired
titlestringOptional
userIdstringOptional
userIdsstring[]Optional
positionstring | integerOptional
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
roomIdstringOptional

reminder: room of the message.

previewstringOptional
authorUserIdstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
issueKeystringOptional

issue-created: the new task.

organisationNamestringOptional
callIdstringOptional
videobooleanOptional
outcome"completed" | "missed" | "declined"Optional
durationSecstring | integerOptional
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
Variant 2
null
attachmentCountstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
insertedDatestringRequired
Variant 2
null
lastMessageDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
blockedByMebooleanRequired

Direct room: I blocked the other person.

isBlockedbooleanRequired

Direct room: a block exists in either direction; sending is disabled.

myLastReadPositionstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
unreadCountstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
myRole"owner" | "member"Required
isMutedbooleanRequired
isPinnedbooleanRequired
insertedDatestringRequired
departmentChannelobject | nullRequired
One of 2:
Variant 1

Department channel: membership follows the structure.

organisationNamestringRequired
Variant 2
null
totalUnreadstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "title": "example_title",
      "participants": [
        {
          "userId": "example_userId",
          "fullName": "example_fullName"
        }
      ],
      "blockedByMe": false,
      "isBlocked": false,
      "isMuted": false,
      "isPinned": false,
      "insertedDate": "example_insertedDate"
    }
  ]
}

Request example

GET /bff/team-chat/inbox

get
curl -X GET "https://api.bizkithub.com/bff/team-chat/inbox" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key