API Reference

Accounts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Contacts

Manage contacts on a specific account

Search contacts

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

GET/v1/accounts/{accountID}/contacts

List contacts

accounts.contacts.list(straccount_id, ContactListParams**kwargs) -> SyncCursorSearch[User]

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

ModelsExpand Collapse

class ContactSearchResponse: …

items: List[User]

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.