chat.bsky.convo.listConvos

Returns a page of conversations (direct or group) for the user.

class atproto_client.models.chat.bsky.convo.list_convos.Params

Bases: ParamsModelBase

Parameters model for chat.bsky.convo.listConvos.

field cursor: str | None = None

Cursor.

field kind: Literal['direct', 'group'] | str | None = None

Filter by conversation kind.

field limit: int | None = None

Limit.

Constraints:

• ge = 1

• le = 100

field lock_status: Literal['unlocked', 'locked', 'locked-permanently'] | str | None = None

field read_state: Literal['unread'] | str | None = None

Read state.

field status: Literal['request', 'accepted'] | str | None = None

class atproto_client.models.chat.bsky.convo.list_convos.ParamsDict

Bases: TypedDict

cursor: NotRequired[str | None]

Cursor.

kind: NotRequired[Literal['direct', 'group'] | str | None]

Filter by conversation kind.

limit: NotRequired[int | None]

Limit.

lock_status: NotRequired[Literal['unlocked', 'locked', 'locked-permanently'] | str | None]

Filter by conversation lock status. Values follow chat.bsky.convo.defs#convoLockStatus.

read_state: NotRequired[Literal['unread'] | str | None]

Read state.

status: NotRequired[Literal['request', 'accepted'] | str | None]

Filter convos by their status. It is discouraged to call with “request” and preferred to call chat.bsky.convo.listConvoRequests, which also includes group join requests made by the user.

class atproto_client.models.chat.bsky.convo.list_convos.Response

Bases: ResponseModelBase

Output data model for chat.bsky.convo.listConvos.

field convos: List[models.ChatBskyConvoDefs.ConvoView] [Required]

Convos.

field cursor: str | None = None

Cursor.