GEgetstream
product:chat

Unread counts

Changed on

Fetch unread counts for a single user

get/unread

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/unread
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Query parameters

user_idstring
include_large_channelsboolean

Also return channels too large to keep an unread count for. They come back with unread_count 0 and has_unread true when they have messages newer than the user's last read.

Response

Successful response

durationstring required

Duration of the request in milliseconds

total_unread_countinteger required

The total number of unread messages.

total_unread_count_by_teamobject

The total number of unread messages grouped by team.

total_unread_threads_countinteger required

The total number of unread threads.

Changes

  • 6b8025dc9af1Revision changes
    • info

      added the new optional query request parameter include_large_channels

    • info

      added the required property // to the response with the status

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status