Skip to content
Download Beeper
API Reference

API Reference

Libraries

npm install @beeper/desktop-api
pip install beeper_desktop_api
go get -u 'github.com/beeper/desktop-api-go@v0.0.1'

API Overview

Accounts

Manage connected chat accounts

AccountsContacts

Manage contacts on a specific account

Search contacts
get/v1/accounts/{accountID}/contacts

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

ChatsReminders

Manage reminders for chats

Create a chat reminder
post/v1/chats/{chatID}/reminders
Delete a chat reminder
delete/v1/chats/{chatID}/reminders

Messages

Manage messages in chats

Search messages
get/v1/messages/search
List messages
get/v1/chats/{chatID}/messages
Send a message
post/v1/chats/{chatID}/messages

Assets

Manage assets in Beeper Desktop, like message attachments

Download an asset
post/v1/assets/download