Skip to content
Download Beeper
API Reference

API Reference

Libraries

npm install @beeper/desktop-api
pip install git+ssh://git@github.com/beeper/desktop-api-python.git
go get -u 'github.com/beeper/desktop-api-go@v0.5.0'
brew install beeper/tap/beeper-desktop-cli
composer require "beeper/desktop-api-php 0.0.1"

API Overview

Accounts

Manage connected chat accounts

AccountsContacts

Manage contacts on a specific account

Search contacts
GET/v1/accounts/{accountID}/contacts
List contacts
GET/v1/accounts/{accountID}/contacts/list

Chats

Manage chats

Retrieve chat details
GET/v1/chats/{chatID}
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

ChatsMessages

Manage chat messages

ChatsMessagesReactions

Manage message reactions

Add a reaction
POST/v1/chats/{chatID}/messages/{messageID}/reactions
Remove a reaction
DELETE/v1/chats/{chatID}/messages/{messageID}/reactions

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
Edit a message
PUT/v1/chats/{chatID}/messages/{messageID}

Assets

Manage assets in Beeper Desktop, like message attachments

Download an asset
POST/v1/assets/download
Upload an asset
POST/v1/assets/upload
Upload an asset (base64)
POST/v1/assets/upload/base64
Serve an asset
GET/v1/assets/serve

Info

Control the Beeper Desktop application