Skip to main content
GET
/
chats
/
unread
Get unread chats, messages, and notifications count
curl --request GET \
  --url https://api.example.com/chats/unread \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Fanvue-API-Version: <x-fanvue-api-version>'
{
  "unreadChatsCount": 5,
  "unreadMessagesCount": 12,
  "unreadNotifications": {
    "newFollower": 3,
    "newPostComment": 2,
    "newPostLike": 8,
    "newPurchase": 1,
    "newSubscriber": 4,
    "newTip": 2,
    "newPromotion": 0
  }
}
Required scope
  • read:chat — Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

​
X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Response

Unread counts retrieved successfully

​
unreadChatsCount
number
required

Number of conversations with unread messages

​
unreadMessagesCount
number
required

Total number of unread messages across all chats

​
unreadNotifications
object
required

Counts of unread notifications by type