FAfanvue

Get unread chats, messages, and notifications count

Returns the count of unread chats, total unread messages, and unread notifications by type for the authenticated user.

<Info> **Polling for real-time updates? Use a webhook instead.**

If you are calling this endpoint on a schedule to detect new activity, subscribe to the message.received, message.read webhook events instead — you'll get pushed updates in real time without polling. See the webhook documentation. </Info>

get/chats/unread

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/chats/unread
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: read:chat

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

Unread counts retrieved successfully

unreadChatsCountnumber required

Number of conversations that are unread: those with unread messages plus those manually marked unread via PATCH /chats/{userUuid}. Use this for unread badges.

unreadMessagesCountnumber required

Total number of unread messages across all chats. A chat manually marked unread adds 0 here, as it has no unread message; it is counted in unreadChatsCount instead.

Changes

No recorded changes to this operation across all 8 revisions of this API.