Skip to content

API Reference / Steam chat

Count chat conversations across the workspace

Return the number of Steam account and counterpart pairs matching the same filter as the conversation list, with the unread messages they hold, so the list's segments and the unread badge agree with the rows.

POST/steam.v1.Steam/CountWorkspaceConversations

Request body

application/jsonRequired

Request for the number of conversation pairs matching a filter across the caller's workspace, with the unread messages they hold.

filter?WorkspaceConversationFilter

The same filter as the conversation list.

Show attributes
accountName?string

Optional exact Steam account name, so the list reads one account's conversations. Absent or empty reads every active account's.

partnerSteamId?string

Optional exact counterpart SteamID for an authorized workspace conversation lookup, including older threads outside loaded sidebar pages. Intersects the other fields when present. Absent or empty reads all matching counterparts.

query?string

Case-insensitive literal substring across partner SteamID, the account name holding the thread, and last-known persona names observed by active workspace accounts. Whitespace is trimmed. Absent or empty matches every conversation.

unread?boolean

True keeps only pairs with unread inbound messages, false keeps only pairs with none, absent keeps both.

Response body

application/json

Success

count?string

Number of account and counterpart pairs matching the filter, across the whole workspace rather than the loaded page.

Format"int64"

historyReadPause?ChatHistoryReadPause

Set when the reading of chat history from before the workspace's accounts were added is paused, with the reason. Unset when nothing is paused.

Show attributes
messageQuota?integer

The workspace's chat history messages quota in force.

Format"int32"

messagesStored?integer

Messages the workspace's reads stored so far.

Format"int32"

reason?string

Why it is paused.

Value in"CHAT_HISTORY_READ_PAUSE_REASON_WORKSPACE_MESSAGE_QUOTA"

unreadMessageCount?string

Sum of the unread inbound messages over the matching pairs.

Format"int64"

curl -X POST "https://api.goldmine.to/steam.v1.Steam/CountWorkspaceConversations" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "unread": true
    }
  }'
{
  "count": "4",
  "unreadMessageCount": "11"
}