Get Channel Counters

Gets channel information related to a user.

HTTP MethodURLRequires Auth



Permission required: view-room-administration

Query Parameters

KeyExample ValueDescription

roomId* or roomName*

ByehQjC44FwMeiLbX or GENERAL

The channel room ID or room name. You must enter at least one of the parameters.



The user ID.

Example Call

curl -H "X-Auth-Token: 8h2mKAwxB3AQrFSjLVKMooJyjdCFaA7W45sWlHP8IzO" \
     -H "X-User-Id: ew28FnZqipDpvKw3R" \
     -H "Content-type: application/json" \

Example Response


// where:

// joined - boolean flag that shows that user has joined the room or not
// members - count of current room members
// unreads - count of unread messages for specified user (calling user or provided userId)
// unreadsFrom - start date-time of unread interval for specified user
// msgs - count of messages in the room
// latest - end date-time of unread interval for specified user (or date-time of last posted message)
// userMentions - count of user mentions in messages

Change Log




Last updated

Rocket.Chat versions receive support for six months after release.