Skip to content

app.bsky.graph.getLists

Lexicon Version: 1

Type: query

Enumerates the lists created by a specified account (actor).

Parameters:

NameTypeReq’dDescriptionConstraints
actorstringThe account (actor) to enumerate lists from.Format: at-identifier
limitintegerMin: 1
Max: 100
Default: 50
cursorstring
purposesArray of stringOptional filter by list purpose. If not specified, all supported types are returned.
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
cursorstring
listsArray of app.bsky.graph.defs#listView

{
"lexicon": 1,
"id": "app.bsky.graph.getLists",
"defs": {
"main": {
"type": "query",
"description": "Enumerates the lists created by a specified account (actor).",
"parameters": {
"type": "params",
"required": [
"actor"
],
"properties": {
"actor": {
"type": "string",
"format": "at-identifier",
"description": "The account (actor) to enumerate lists from."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
},
"purposes": {
"type": "array",
"description": "Optional filter by list purpose. If not specified, all supported types are returned.",
"items": {
"type": "string",
"knownValues": [
"modlist",
"curatelist"
]
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"lists"
],
"properties": {
"cursor": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "ref",
"ref": "app.bsky.graph.defs#listView"
}
}
}
}
}
}
}
}