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

/bff/team-chat/pins

Pinned messages of a team chat room (ascending by position)

Team chatgetBffTeam-chatPins

Parameters

1 query

Query parameters

· 1
roomIdstringRequired

24-char room id.

Length: 24–24
Exampleexample_roomId

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
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
contentstringRequired
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
attachmentsobject[]Required
Each array item:
tokenstringRequired
filenamestringRequired
sizenumberRequired
contentTypestringRequired
isImagebooleanRequired
clientNoncestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
insertedDatestringRequired
isDeletedbooleanRequired
editedDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
replyToobject | nullRequired
One of 2:
Variant 1
idstringRequired
positionstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
authorUserIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
previewstringRequired
attachmentCountstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
isDeletedbooleanRequired
Variant 2
null
reactionsobject[]Required
Each array item:
emojistringRequired
userIdsstring[]Required
mentionsstring[]Required
pinnedDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
isForwardedbooleanRequired
pollobject | nullRequired
One of 2:
Variant 1
questionstringRequired
multiplebooleanRequired
anonymousbooleanRequired

Voters are hidden from everybody (voterIds empty).

closedDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
totalVotersstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
optionsobject[]Required
Each array item:
idstringRequired
textstringRequired
countstring | integerRequired
One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer
voterIdsstring[]Required
Variant 2
null
linkPreviewobject | nullRequired
One of 2:
Variant 1
urlstringRequired
titlestringRequired
descriptionstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
imagestring | nullRequired
One of 2:
Variant 1
string

Third-party image URL; load it through proxy.bizkithub.com.

Variant 2
null
siteNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
Variant 2
null
threadRootIdstring | nullRequired
One of 2:
Variant 1
string

Thread reply: wire id of the root message.

Variant 2
null
threadReplyCountstring | integerRequired

Thread root: live replies.

One of 2:
Variant 1
stringinteger
Default: 0
Variant 2
integer

Thread root: live replies.

threadLastReplyDatestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "content": "example_content",
      "attachments": [
        {
          "token": "example_token",
          "filename": "example_filename",
          "size": 0,
          "contentType": "example_contentType",
          "isImage": false
        }
      ],
      "insertedDate": "example_insertedDate",
      "isDeleted": false,
      "reactions": [
        {
          "emoji": "example_emoji",
          "userIds": [
            "string"
          ]
        }
      ],
      "mentions": [
        "string"
      ],
      "isForwarded": false
    }
  ]
}

Request example

GET /bff/team-chat/pins

get
curl -X GET "https://api.bizkithub.com/bff/team-chat/pins?roomId=example_roomId" \
  -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