games.gamesgamesgamesgames.getUserLists

gamesgamesgamesgames.games

Documentation

Get a user's lists with item counts. Optionally check which lists contain a specific game.

main query

Get a user's lists with item counts. Optionally check which lists contain a specific game.

Parameters

cursor string Optional

No description available.

did string Required

The DID of the user whose lists to retrieve.

gameUri string at-uri Optional

If provided, each list includes a hasGame boolean indicating whether this game is in the list.

limit integer Optional

No description available.

Output

Encodingapplication/json
cursor string Optional

No description available.

lists array Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The DID of the user whose lists to retrieve.
If provided, each list includes a hasGame boolean indicating whether this game is in the list.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "lists"
      ],
      "properties": {
        "lists": {
          "type": "array",
          "items": {
            "ref": "#userListView",
            "type": "ref"
          }
        },
        "cursor": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "did"
    ],
    "properties": {
      "did": {
        "type": "string",
        "description": "The DID of the user whose lists to retrieve."
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      },
      "gameUri": {
        "type": "string",
        "format": "at-uri",
        "description": "If provided, each list includes a hasGame boolean indicating whether this game is in the list."
      }
    }
  },
  "description": "Get a user's lists with item counts. Optionally check which lists contain a specific game."
}
listPreviewItem object

No description available.

Properties

media unknown Optional

No description available.

name string Required

No description available.

slug string Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "name"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "media": {
      "type": "unknown"
    }
  }
}
userListView object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

hasGame boolean Optional

No description available.

itemCount integer Required

No description available.

name string Required

No description available.

previewItems array of ref#listPreviewItem Optional

No description available.

maxLength: 4 items
uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "name",
    "itemCount",
    "createdAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "name": {
      "type": "string"
    },
    "hasGame": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "itemCount": {
      "type": "integer"
    },
    "description": {
      "type": "string"
    },
    "previewItems": {
      "type": "array",
      "items": {
        "ref": "#listPreviewItem",
        "type": "ref"
      },
      "maxLength": 4
    }
  }
}

Lexicon Garden

@