# games.gamesgamesgamesgames.getUserLists

> Published by [gamesgamesgamesgames.games](https://lexicon.garden/identity/did:web:gamesgamesgamesgames.games)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:gamesgamesgamesgames.games/games.gamesgamesgamesgames.getUserLists)
- [Documentation](https://lexicon.garden/lexicon/did:web:gamesgamesgamesgames.games/games.gamesgamesgamesgames.getUserLists/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:gamesgamesgamesgames.games/games.gamesgamesgamesgames.getUserLists/examples)

## Definitions

### `games.gamesgamesgamesgames.getUserLists`

**Type**: `query`

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

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` | Yes | The DID of the user whose lists to retrieve. |
| `limit` | `integer` | No |  |
| `cursor` | `string` | No |  |
| `gameUri` | `string` (at-uri) | No | If provided, each list includes a hasGame boolean indicating whether this game is in the list. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `lists` | `array` | Yes |  |
| `cursor` | `string` | No |  |

### `games.gamesgamesgamesgames.getUserLists#userListView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes |  |
| `name` | `string` | Yes |  |
| `hasGame` | `boolean` | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `itemCount` | `integer` | Yes |  |
| `description` | `string` | No |  |
| `previewItems` | `array` | No |  |

### `games.gamesgamesgamesgames.getUserLists#listPreviewItem`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes |  |
| `name` | `string` | Yes |  |
| `slug` | `string` | No |  |
| `media` | `unknown` | No |  |

## Raw Schema

```json
{
  "id": "games.gamesgamesgamesgames.getUserLists",
  "defs": {
    "main": {
      "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."
    },
    "userListView": {
      "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
        }
      }
    },
    "listPreviewItem": {
      "type": "object",
      "required": [
        "uri",
        "name"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "name": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "media": {
          "type": "unknown"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```