app.bsky.graph.getListsWithMembership

bsky-lexicons.bsky.social

Documentation

Enumerates the lists created by the session user, and includes membership information about `actor` in those lists. Only supports curation and moderation lists (no reference lists, used in starter packs). Requires auth.

main query

Enumerates the lists created by the session user, and includes membership information about `actor` in those lists. Only supports curation and moderation lists (no reference lists, used in starter packs). Requires auth.

Parameters

actor string at-identifier Required

The account (actor) to check for membership.

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.

listsWithMembership 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 account (actor) to check for membership.
Optional filter by list purpose. If not specified, all supported types are returned.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "listsWithMembership"
      ],
      "properties": {
        "cursor": {
          "type": "string"
        },
        "listsWithMembership": {
          "type": "array",
          "items": {
            "ref": "#listWithMembership",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "actor"
    ],
    "properties": {
      "actor": {
        "type": "string",
        "format": "at-identifier",
        "description": "The account (actor) to check for membership."
      },
      "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 the session user, and includes membership information about `actor` in those lists. Only supports curation and moderation lists (no reference lists, used in starter packs). Requires auth."
}
listWithMembership object

A list and an optional list item indicating membership of a target user to that list.

Properties

View raw schema 
{
  "type": "object",
  "required": [
    "list"
  ],
  "properties": {
    "list": {
      "ref": "app.bsky.graph.defs#listView",
      "type": "ref"
    },
    "listItem": {
      "ref": "app.bsky.graph.defs#listItemView",
      "type": "ref"
    }
  },
  "description": "A list and an optional list item indicating membership of a target user to that list."
}

Lexicon Garden

@