Chats

API Reference

Chats

Chats operations

Archive or unarchive a chat

post/v0/archive-chat

Retrieve chat details

get/v0/get-chat

Search chats

get/v0/search-chats

ModelsExpand Collapse

Chat = object { id, accountID, network, 10 more }

id: string

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

accountID: string

Beeper account ID this chat belongs to.

network: string

Display-only human-readable network name (e.g., 'WhatsApp', 'Messenger'). You MUST use 'accountID' to perform actions.

participants: object { hasMore, items, total }

Chat participants information.

hasMore: boolean

True if there are more participants than included in items.

items: array of User

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

total: number

Total number of participants in the chat.

title: string

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

type: "single" or "group"

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

Accepts one of the following:

"single"

"group"

unreadCount: number

Number of unread messages.

isArchived: optional boolean

True if chat is archived.

isMuted: optional boolean

True if chat notifications are muted.

isPinned: optional boolean

True if chat is pinned.

lastActivity: optional string

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

formatdate-time

lastReadMessageSortKey: optional number or string

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

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

localChatID: optional string

Local chat ID specific to this Beeper Desktop installation.

ChatsReminders

Reminders operations

Create a chat reminder

post/v0/set-chat-reminder

Delete a chat reminder

post/v0/clear-chat-reminder