Skip to main content
GET
/
public
/
messages
/
unreadCounts
Unread Message Counts
curl --request GET \
  --url https://web-api.clerk.chat/public/messages/unreadCounts \
  --header 'apiKey: <api-key>'
{
  "unreadMessageCounts": {
    "<INBOX_ID>": {
      "<USER_ID>": 10
    }
  }
}

Authorizations

​
apiKey
string
header
required

Query Parameters

​
inboxIds
string[]

The IDs of the Inboxes to filter unread message counts by. If not provided, all inboxes will be included. You must include at least one of the documented query parameters: inboxIds or userIds.

​
userIds
string[]

The IDs of Users to filter unread message counts by. If not provided, all users will be included. You must include at least one of the documented query parameters: inboxIds or userIds.

Response

Object of Unread Counts organized by Inbox Ids

​
unreadMessageCounts
object
required
Example:
{ "<INBOX_ID>": { "<USER_ID>": 10 } }
⌘I