---
search:
  tags:
    - Accounts
    - POST
seo:
  description: >-
    List account friends. Reference for the POST /v1/account.listFriends
    endpoint in the SteamSets API.
sidebar:
  label: List account friends
  badge: POST
title: List account friends
type: openapi-operation
---
`POST /v1/account.listFriends`

**Request body** (`application/json`, required)

- `cursor` (string) — Opaque cursor from a previous page's nextCursor. Omit for the first page
- `id` (IDSearch)
- `includeStats` (boolean) — Add averages over all friends to the response
- `limit` (integer<int64>) — Friends per page
- `offset` (integer<int64>) — Number of friends to skip, to go to a page directly. Ignored when cursor is set
- `order` (string) — Sort direction
- `search` (string) — Return only friends whose name contains this text. The match ignores case
- `sort` (string) — Sort key. Equal keys keep the friendsSince order (newest first, then account id)
- `vanity` (VanitySearch)

Request body example:

```json
{
  "cursor": "string",
  "id": {
    "accountId": 0,
    "steamId64": "stringstringstrin"
  },
  "includeStats": true,
  "limit": 100,
  "offset": 0,
  "order": "asc",
  "search": "string",
  "sort": "friendsSince",
  "vanity": {
    "type": "steam",
    "value": "string"
  }
}
```

**Responses**

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

Response example, 200:

```json
{
  "filteredTotal": 0,
  "friends": [
    {
      "animatedAvatar": "string",
      "apps": 123456,
      "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
      "avatarFrame": "string",
      "awardsGiven": 123456,
      "awardsReceived": 123456,
      "background": "string",
      "badges": 123456,
      "bans": 0,
      "city": {
        "name": "Bad Krozingen"
      },
      "country": {
        "code": "DE",
        "name": "Germany"
      },
      "createdAt": "2023-01-01T00:00:00Z",
      "donated": 123456,
      "economyBan": "steam",
      "foilBadges": 123456,
      "friends": 123456,
      "friendsSince": "2019-08-24T14:15:22Z",
      "gameBans": 0,
      "level": 123456,
      "miniBackground": "string",
      "name": "steamsets",
      "nameEffect": "rainbow",
      "normalBadges": 123456,
      "playtime": 123456,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "region": {
        "name": "Europe"
      },
      "roles": [
        {
          "extras": {
            "property1": null,
            "property2": null
          },
          "rating": 0,
          "role": "user"
        }
      ],
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsScore": 0,
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "supporter": {
        "active": true,
        "months": 3
      },
      "themeColor": "#FF5733",
      "vacBans": 0,
      "xp": 123456
    }
  ],
  "nextCursor": "string",
  "stats": {
    "averageBadges": 0,
    "averageLevel": 0
  },
  "total": 0
}
```