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

client.accounts.contacts.search(stringaccountID, ContactSearchParams { query } query, RequestOptionsoptions?): ContactSearchResponse { items }

GET/v1/accounts/{accountID}/contacts

List contacts

client.accounts.contacts.list(stringaccountID, ContactListParams { cursor, direction, limit, query } query?, RequestOptionsoptions?): CursorSearch<User { id, cannotMessage, email, 5 more } >

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

ModelsExpand Collapse

ContactSearchResponse { items }

items: Array<User { id, cannotMessage, email, 5 more } >

id: string

Stable Beeper user ID. Use as the primary key when referencing a person.

cannotMessage?: boolean

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?: string

Email address if known. Not guaranteed verified.

fullName?: string

Display name as shown in clients (e.g., ‘Alice Example’). May include emojis.

imgURL?: string

Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.

isSelf?: boolean

True if this user represents the authenticated account’s own identity.

phoneNumber?: string

User’s phone number in E.164 format (e.g., ‘+14155552671’). Omit if unknown.

username?: string

Human-readable handle if available (e.g., ‘@alice’). May be network-specific and not globally unique.