API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Accounts

Manage connected chat accounts

List connected accounts

$client->accounts->list(): AccountListResponse

GET/v1/accounts

ModelsExpand Collapse

Account

string accountID

Chat account added to Beeper. Use this to route account-scoped actions.

User user

User the account belongs to.

AccountsContacts

Manage contacts on a specific account

Search contacts

$client->accounts->contacts->search(string accountID, string query): ContactSearchResponse

GET/v1/accounts/{accountID}/contacts

List contacts

$client->accounts->contacts->list(string accountID, ?string cursor, ?Direction direction, ?int limit, ?string query): CursorSearch<User>

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