API Reference

Accounts

Manage connected chat accounts

List connected accounts

accounts.list() -> AccountListResponse

get/v1/accounts

ModelsExpand Collapse

class Account: …

A chat account added to Beeper

account_id: str

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

Deprecatednetwork: str

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

user: User

User the account belongs to.

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.

AccountsContacts

Manage contacts on a specific account

Search contacts

accounts.contacts.search(straccount_id, ContactSearchParams**kwargs) -> ContactSearchResponse

get/v1/accounts/{accountID}/contacts