---
title: "List account friends"
method: POST
path: "/v1/account.listFriends"
tags: ["account"]
---

# List account friends

`POST /v1/account.listFriends`

## Request body

- V1AccountListFriendsRequestBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `cursor` string — Opaque cursor from a previous page's nextCursor. Omit for the first page
  - `id` IDSearch
    - `accountId` integer — Account ID to search for
    - `steamId64` string — SteamID64 to search for
  - `limit` integer — Friends per page
  - `vanity` VanitySearch
    - `type` 'steam' | 'internal', required — Which type of vanity to search for
    - `value` string, required — Vanity to search for

## Response `200`

OK

- V1AccountListFriendsResponseBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `friends` V1AccountFriend[], nullable, required
    - `animatedAvatar` string, required — The animated avatar of the account
    - `apps` integer, required — The number of apps the account has
    - `avatar` string, required — The avatar hash of the account
    - `avatarFrame` string, required — The avatar frame of the account
    - `awardsGiven` integer, required — The number of awards the account has
    - `awardsReceived` integer, required — The number of awards the account has
    - `background` string, required — The background of the account
    - `badges` integer, required — The number of badges the account has
    - `bans` integer, required — The number of bans
    - `city` LeaderboardCity, nullable
      - `name` string, required — The name of the city
    - `country` LeaderboardCountry, nullable
      - `code` string — The code of the country
      - `name` string, required — The name of the country
    - `createdAt` string, date-time, required — The time the account was created
    - `donated` integer, required — The total of donations the account has
    - `economyBan` string, required — The economy ban of the account
    - `foilBadges` integer, required — The number of foil badges the account has
    - `friends` integer, required — The number of friends the account has
    - `friendsSince` string, date-time, nullable, required
    - `gameBans` integer, required — The number of game bans
    - `level` integer, required — The level of the account
    - `miniBackground` string, required — The mini background of the account
    - `name` string, required — The name of the account
    - `nameEffect` 'none' | 'rainbow' | 'glitch' | 'shadow' | 'neon' | 'retro' | 'stamped' | 'shatter' | 'typewriter' | 'vaporwave' | 'sunken', required — Donator name effect, none when unset or the account no longer holds an entitling role
    - `normalBadges` integer, required — The number of normal badges the account has
    - `playtime` integer, required — The playtime of the account
    - `pointsGiven` integer, required — The number of points the account has
    - `pointsReceived` integer, required — The number of points the account has
    - `privacy` 'public' | 'private' | 'friends_only', required — The privacy of the account
    - `region` LeaderboardRegion, nullable
      - `name` string, required — The name of the region
    - `roles` Role[], nullable, required — The roles of the account
      - `extras` object, nullable, required — Extra data associated with the role
      - `rating` integer, required — The higher the more presedence it has
      - `role` 'user' | 'donator' | 'staff' | 'developer' | 'partner' | 'owner' | 'amethyst' | 'amber' | 'emerald' | 'sapphire' | 'ruby' | 'diamond' | 'contributor' | 'early_supporter' | 'beta' | 'translator' | 'top_100' | 'badge_scout' | 'nitro_booster' | 'astral' | 'nebula', required
    - `state` LeaderboardState, nullable
      - `name` string, required — The name of the state
    - `steamId` string, required — The steam id
    - `steamSetsScore` integer, required — The steam sets score
    - `steamSetsVanity` string, required — The vanity of the account
    - `steamVanity` string, required — The vanity of the account
    - `themeColor` string, nullable, required — Donator profile theme color as #RRGGBB (no alpha), null when unset or the account no longer holds an entitling role
    - `vacBans` integer, required — The number of vac bans
    - `xp` integer, required — The number of xp the account has
  - `nextCursor` string, nullable, required — Cursor for the next page, null when this is the last page
  - `total` integer, required — Total number of friends across all pages

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/steamsets/apis/steamsets-api.md) · [All operations](https://skmtc.net/steamsets/apis/steamsets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steamsets/steamsets-api/versions/2e8ba266b27f/schema)