Chats

Manage chats

Retrieve chat details

get/v1/chats/{chatID}

Create a chat

post/v1/chats

List chats

get/v1/chats

Search chats

get/v1/chats/search

Archive or unarchive a chat

post/v1/chats/{chatID}/archive

ModelsExpand Collapse

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

id: string

Unique identifier of the chat across Beeper.

accountID: string

Account ID this chat belongs to.

Deprecatednetwork: string

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

participants: object { hasMore, items, total }

Chat participants information.

hasMore: boolean

True if there are more participants than included in items.

items: array of User { id, cannotMessage, email, 5 more }

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

id: string

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

cannotMessage: optional boolean

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 string

Email address if known. Not guaranteed verified.

fullName: optional string

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

imgURL: optional string

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

isSelf: optional boolean

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

phoneNumber: optional string

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

username: optional string

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

total: number

Total number of participants in the chat.

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.

description: optional string

Description of the chat.

isArchived: optional boolean

True if chat is archived.

isMuted: optional boolean

True if the chat is muted.

isPinned: optional boolean

True if the chat is pinned.

lastActivity: optional string

Timestamp of last activity.

formatdate-time

lastReadMessageSortKey: optional string

Last read message sortKey.

localChatID: optional string

Local chat ID specific to this Beeper Desktop installation.

title: optional string

Display title of the chat.

ChatsReminders

Manage reminders for chats

Create a chat reminder

post/v1/chats/{chatID}/reminders

Delete a chat reminder

delete/v1/chats/{chatID}/reminders