app.bsky.graph.getListsWithMembership

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.

class atproto_client.models.app.bsky.graph.get_lists_with_membership.Params

Bases: ParamsModelBase

Parameters model for app.bsky.graph.getListsWithMembership.

field actor: AtIdentifier [Required]

The account (actor) to check for membership.

field cursor: str | None = None

Cursor.

field limit: int | None = None

Limit.

Constraints:
  • ge = 1

  • le = 100

field purposes: List[Literal['modlist', 'curatelist'] | str] | None = None
class atproto_client.models.app.bsky.graph.get_lists_with_membership.ParamsDict

Bases: TypedDict

actor: AtIdentifier

The account (actor) to check for membership.

cursor: NotRequired[str | None]

Cursor.

limit: NotRequired[int | None]

Limit.

purposes: NotRequired[List[Literal['modlist', 'curatelist'] | str] | None]

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

class atproto_client.models.app.bsky.graph.get_lists_with_membership.Response

Bases: ResponseModelBase

Output data model for app.bsky.graph.getListsWithMembership.

field cursor: str | None = None

Cursor.

field lists_with_membership: List[models.AppBskyGraphGetListsWithMembership.ListWithMembership] [Required]

Lists with membership.

class atproto_client.models.app.bsky.graph.get_lists_with_membership.ListWithMembership

Bases: ModelBase

Definition model for app.bsky.graph.getListsWithMembership. A list and an optional list item indicating membership of a target user to that list.

field list: models.AppBskyGraphDefs.ListView [Required]

List.

field list_item: models.AppBskyGraphDefs.ListItemView | None = None

List item.