Skip to content

API Reference / Steam chat

List chat conversations across the workspace

Return one conversation per Steam account and counterpart pair across the workspace, ordered by each pair's most recent message, with the newest message, who wrote it, the unread count and the open trade offers between the pair. Filters by text, counterpart, account and unread state apply before pagination.

POST/steam.v1.Steam/ListWorkspaceConversations

Request body

application/jsonRequired

Request for one page of conversations across every Steam account in the workspace, one row per account and counterpart pair, ordered by most recent message.

cursor?string

Opaque cursor bound to the authorized workspace, normalized filter, and newest-message order. Empty for the first page. Reset when any predicate changes. Legacy unscoped cursors are rejected.

filter?WorkspaceConversationFilter

Optional filters applied to the complete set of workspace conversation pairs before pagination. Keep unchanged on continuation pages.

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.

limit?integer

Maximum number of conversations to return. Server caps this at a service-defined upper bound.

Format"int32"

Response body

application/json

Success

conversations?array<WorkspaceConversation>

Conversation pairs, newest message first.

Show attributes
accountName?string

The Steam account holding this thread.

lastMessageAt?string

When the newest message between this account and the counterpart was sent.

Format"date-time"

lastMessageDirection?string

Whether the account sent or received the newest message, so the row can say who wrote it.

Value in"CHAT_MESSAGE_DIRECTION_INBOUND""CHAT_MESSAGE_DIRECTION_OUTBOUND"

lastMessagePreview?string

Body text of the newest message between this account and the counterpart.

openTradeOfferCount?integer

Trade offers between this account and the counterpart that are awaiting a confirmation, active or in escrow, excluding imported history.

Format"int32"

partnerSteamId?string

The counterpart's 64-bit SteamID.

unreadCount?integer

Number of inbound messages newer than this account's read cursor for the counterpart.

Format"int32"

nextCursor?string

Cursor to pass to fetch the next page. Empty when there are no more results.

curl -X POST "https://api.goldmine.to/steam.v1.Steam/ListWorkspaceConversations" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 50
  }'
{
  "conversations": [
    {
      "partnerSteamId": "76561198044443322",
      "lastMessageAt": "2026-06-29T11:52:00Z",
      "lastMessagePreview": "Hi, your item has been sent!",
      "unreadCount": 2,
      "accountName": "trader_bot_01",
      "lastMessageDirection": "CHAT_MESSAGE_DIRECTION_OUTBOUND",
      "openTradeOfferCount": 1
    }
  ],
  "nextCursor": "eyJ0cyI6IjIwMjYtMDYtMjkifQ=="
}