app.bsky.graph.get_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.

field py_type: Literal['app.bsky.graph.getListsWithMembership#listWithMembership'] = 'app.bsky.graph.getListsWithMembership#listWithMembership'¶
class atproto_client.models.app.bsky.graph.get_lists_with_membership.Params¶

Bases: ParamsModelBase

Parameters model for app.bsky.graph.getListsWithMembership.

field actor: str | str [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'] | Literal['curatelist'] | str] | None = None¶
class atproto_client.models.app.bsky.graph.get_lists_with_membership.ParamsDict¶

Bases: TypedDict

actor: str¶

The account (actor) to check for membership.

cursor: typing_extensions.NotRequired[str | None]¶

Cursor.

limit: typing_extensions.NotRequired[int | None]¶

Limit.

purposes: typing_extensions.NotRequired[List[Literal['modlist'] | Literal['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.