Skip to content
Beeper Developer Docs
Download Beeper
API Reference

Chats

Manage chats

Retrieve chat details
chats.retrieve(strchat_id, ChatRetrieveParams**kwargs) -> Chat
GET/v1/chats/{chatID}
Create or start a chat
chats.create(ChatCreateParams**kwargs) -> ChatCreateResponse
POST/v1/chats
List chats
chats.list(ChatListParams**kwargs) -> SyncCursorNoLimit[ChatListResponse]
GET/v1/chats
Search chats
chats.search(ChatSearchParams**kwargs) -> SyncCursorSearch[Chat]
GET/v1/chats/search
Archive or unarchive a chat
chats.archive(strchat_id, ChatArchiveParams**kwargs)
POST/v1/chats/{chatID}/archive
ModelsExpand Collapse
class Chat: …
id: str

Unique identifier of the chat across Beeper.

account_id: str

Account ID this chat belongs to.

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.

formatdate-time
last_read_message_sort_key: Optional[str]

Last read message sortKey.

local_chat_id: Optional[str]

Local chat ID specific to this Beeper Desktop installation.

ChatsReminders

Manage reminders for chats

Create a chat reminder
chats.reminders.create(strchat_id, ReminderCreateParams**kwargs)
POST/v1/chats/{chatID}/reminders
Delete a chat reminder
chats.reminders.delete(strchat_id)
DELETE/v1/chats/{chatID}/reminders

ChatsMessages

Manage chat messages

ChatsMessagesReactions

Manage message reactions

Add a reaction
chats.messages.reactions.add(strmessage_id, ReactionAddParams**kwargs) -> ReactionAddResponse
POST/v1/chats/{chatID}/messages/{messageID}/reactions
Remove a reaction
chats.messages.reactions.delete(strmessage_id, ReactionDeleteParams**kwargs) -> ReactionDeleteResponse
DELETE/v1/chats/{chatID}/messages/{messageID}/reactions