Chats

API Reference

Chats

Chats operations

Archive or unarchive a chat

chats.archive(strchat_id, ChatArchiveParams**kwargs) -> BaseResponse

post/v1/chats/{chatID}/archive

Create a chat

chats.create(ChatCreateParams**kwargs) -> ChatCreateResponse

post/v1/chats

List chats

chats.list(ChatListParams**kwargs) -> SyncCursorList[ChatListResponse]

get/v1/chats

Retrieve chat details

chats.retrieve(strchat_id, ChatRetrieveParams**kwargs) -> Chat

get/v1/chats/{chatID}

ModelsExpand Collapse

class Chat: …

id: str

Unique identifier of the chat (room/thread ID, same as id) across Beeper.

account_id: str

Beeper account ID this chat belongs to.

network: str

Display-only human-readable network name (e.g., 'WhatsApp', 'Messenger').

participants: Participants

Chat participants information.

has_more: bool

True if there are more participants than included in items.

items: List[User]

Participants returned for this chat (limited by the request; may be a subset).

id: str

Stable Beeper user ID. Use as the primary key when referencing a person.

cannot_message: Optional[bool]

True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.

email: Optional[str]

Email address if known. Not guaranteed verified.

full_name: Optional[str]

Display name as shown in clients (e.g., 'Alice Example'). May include emojis.

img_url: Optional[str]

Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.

is_self: Optional[bool]

True if this user represents the authenticated account's own identity.

phone_number: Optional[str]

User's phone number in E.164 format (e.g., '+14155552671'). Omit if unknown.

username: Optional[str]

Human-readable handle if available (e.g., '@alice'). May be network-specific and not globally unique.

total: int

Total number of participants in the chat.

title: str

Display title of the chat as computed by the client/server.

type: Literal["single", "group"]

Chat type: 'single' for direct messages, 'group' for group chats.

Accepts one of the following:

"single"

"group"

unread_count: int

Number of unread messages.

is_archived: Optional[bool]

True if chat is archived.

is_muted: Optional[bool]

True if chat notifications are muted.

is_pinned: Optional[bool]

True if chat is pinned.

last_activity: Optional[datetime]

Timestamp of last activity. Chats with more recent activity are often more important.

formatdate-time

last_read_message_sort_key: Optional[Union[int, str, null]]

Last read message sortKey (hsOrder). Used to compute 'isUnread'.

Accepts one of the following:

LastReadMessageSortKeyUnionMember0 = int

LastReadMessageSortKeyUnionMember1 = str

local_chat_id: Optional[str]

Local chat ID specific to this Beeper Desktop installation.

ChatsReminders

Reminders operations

Create a chat reminder

chats.reminders.create(strchat_id, ReminderCreateParams**kwargs) -> BaseResponse

post/v1/chats/{chatID}/reminders

Delete a chat reminder

chats.reminders.delete(strchat_id) -> BaseResponse

delete/v1/chats/{chatID}/reminders