app.bsky.graph.getLists Documentation (EN)

main query

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

Parameters

actor string at-identifier Required

The account (actor) to enumerate lists from.

cursor string Optional

No description available.

limit integer Optional

No description available.

purposes array of string Optional

Optional filter by list purpose. If not specified, all supported types are returned.

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.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

actor * The account (actor) to enumerate lists from.

cursor

limit

purposes Optional filter by list purpose. If not specified, all supported types are returned.

View raw schema

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