games.gamesgamesgamesgames.getUserLists
Get a user's lists with item counts. Optionally check which lists contain a specific game.
Details · query
| Kind | query |
|---|---|
| Authority | gamesgamesgamesgames.games |
| Indexed |
Checks
Validunlimited-stringdefs.listPreviewItem.properties.nameNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.listPreviewItem.properties.slugNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.cursorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.didNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.cursorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.userListView.properties.descriptionNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.userListView.properties.nameNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"listPreviewItem": {
"properties": {
"media": {
"type": "unknown"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"uri": {
"format": "at-uri",
"type": "string"
}
},
"required": [
"uri",
"name"
],
"type": "object"
},
"main": {
"description": "Get a user's lists with item counts. Optionally check which lists contain a specific game.",
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"cursor": {
"type": "string"
},
"lists": {
"items": {
"ref": "#userListView",
"type": "ref"
},
"type": "array"
}
},
"required": [
"lists"
],
"type": "object"
}
},
"parameters": {
"properties": {
"cursor": {
"type": "string"
},
"did": {
"description": "The DID of the user whose lists to retrieve.",
"type": "string"
},
"gameUri": {
"description": "If provided, each list includes a hasGame boolean indicating whether this game is in the list.",
"format": "at-uri",
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"required": [
"did"
],
"type": "params"
},
"type": "query"
},
"userListView": {
"properties": {
"createdAt": {
"format": "datetime",
"type": "string"
},
"description": {
"type": "string"
},
"hasGame": {
"type": "boolean"
},
"itemCount": {
"type": "integer"
},
"name": {
"type": "string"
},
"previewItems": {
"items": {
"ref": "#listPreviewItem",
"type": "ref"
},
"maxLength": 4,
"type": "array"
},
"uri": {
"format": "at-uri",
"type": "string"
}
},
"required": [
"uri",
"name",
"itemCount",
"createdAt"
],
"type": "object"
}
},
"id": "games.gamesgamesgamesgames.getUserLists",
"lexicon": 1
}