API Reference / Steam friends
Search the friends of every Steam account in the workspace
Return one row per person who is a Steam friend of at least one of the workspace's accounts, with their last observed display name, avatar and online state, the accounts that are friends with them, and when the newest message with them was sent. Search by display name, SteamID or profile link, optionally limited to some accounts. Reads what the accounts' sessions last observed and does not contact Steam.
/ steam. v1. Steam/ ListWorkspaceFriendsRequest body
application/jsonRequired
Request for one page of the people who are Steam friends of the workspace's accounts, one row per person, ordered by the best text match, then online before offline, then the most recent conversation.
cursor?stringOpaque cursor bound to the authorized workspace, the normalized filter and the order. Empty for the first page. Reset when the filter changes.
filter?WorkspaceFriendFilterOptional filters applied to every friend of the workspace's accounts before pagination. Keep unchanged on continuation pages.
Show attributes
accountNames?array<string>Steam account names whose friends to search. Empty searches the friends of every active account in the workspace.
query?stringText to find a person by. A 64-bit SteamID or a steamcommunity.com/profiles/ link matches that person exactly. Any other text is a case-insensitive substring of the person's display name. Whitespace is trimmed. Absent or empty matches every friend.
relationship?stringWhich people to list: the accounts' established friends (absent, unspecified or FRIEND), or the people who sent one of the accounts a friend request it has not answered (REQUEST_RECEIVED). Each person's accounts are the accounts with that relationship to them.
Value in"WORKSPACE_"WORKSPACE_
limit?integerMaximum number of people to return. Server caps this at a service-defined upper bound.
Format"int32"
Response body
application/json
Success
friends?array<WorkspaceFriend>People, best text match first, then online before offline, then the most recent conversation.
Show attributes
accounts?array<WorkspaceFriendAccount>The workspace's accounts that are friends with the person, by account name.
Show attributes
accountName?stringThe workspace's Steam account that is friends with the person.
lastMessageAt?stringWhen the newest message between this account and the person was sent. Unset when they have no conversation.
Format"date-time"
avatarHash?stringThe person's raw Steam avatar hash, used to derive the avatar image URL. Empty falls back to an initials placeholder.
Format"byte" base64
gameName?stringName of the game the person is playing. Empty when not in a game.
lastMessageAt?stringWhen the newest message between any of the workspace's accounts and the person was sent. Unset when there is no conversation.
Format"date-time"
observedAt?stringWhen the persona was observed. Unset when no persona has been observed for the person yet.
Format"date-time"
playerName?stringThe person's display name, as last observed by any of the workspace's accounts. Empty until a persona has been observed.
state?integerRaw Steam EPersonaState value for the person's online status: 0 offline, 1 online, 2 busy, 3 away, 4 snooze, 5 looking to trade, 6 looking to play.
Format"int32"
steamId?stringThe person's 64-bit SteamID.
Format"int64"
nextCursor?stringCursor to pass to fetch the next page. Empty when there are no more results.
application/json
The request was malformed, such as a missing required field or an unparseable cursor.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
curl -X POST "https://api.goldmine.to/steam.v1.Steam/ListWorkspaceFriends" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filter": {
"query": "buyer"
},
"limit": 20
}'const res = await fetch("https://api.goldmine.to/steam.v1.Steam/ListWorkspaceFriends", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"filter": {
"query": "buyer"
},
"limit": 20
}),
});
const data = await res.json();body := strings.NewReader(`{
"filter": {
"query": "buyer"
},
"limit": 20
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/steam.v1.Steam/ListWorkspaceFriends", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/steam.v1.Steam/ListWorkspaceFriends",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"filter": {
"query": "buyer"
},
"limit": 20
},
)
data = res.json(){
"friends": [
{
"steamId": "76561198044443322",
"playerName": "BuyerOne",
"state": 1,
"observedAt": "2026-06-29T11:56:00Z",
"accounts": [
{
"accountName": "trader_bot_01",
"lastMessageAt": "2026-06-29T11:52:00Z"
}
],
"lastMessageAt": "2026-06-29T11:52:00Z"
}
]
}{
"code": "invalid_argument",
"message": "The request was malformed, such as a missing required field or an unparseable cursor."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}