Skip to main content
GET
Get unread message channels for a user

Authorizations

X-API-KEY
string
header
required

Query Parameters

userId
string

Internal user or client id whose unread channels to summarize. Defaults to the requester's user id.

Response

OK

totalUnreadCount
integer

TotalUnreadCount is the aggregate number of unread messages across all returned channels.

Example:

5

unreadChannels
object[]

UnreadChannels are the channels in which the member has at least one unread message.