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

GET/v1/accounts

ModelsExpand Collapse

Account object { accountID, bridge, network, user }

A chat account added to Beeper

accountID: string

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

bridge: object { id, provider, type }

Bridge metadata for the account. Available from Beeper Desktop v.4.2.719+.

id: string

Bridge instance identifier.

provider: "cloud" or "self-hosted" or "local" or "platform-sdk"

Bridge provider for the account.

One of the following:

"cloud"

"self-hosted"

"local"

"platform-sdk"

type: string

Bridge type.

network: string

Human-friendly network name for the account.

user: User { id, cannotMessage, email, 5 more }

User the account belongs to.

id: string

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

cannotMessage: optional 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: optional string

Email address if known. Not guaranteed verified.

fullName: optional string

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

imgURL: optional string

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

isSelf: optional boolean

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

phoneNumber: optional string

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

username: optional string

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

AccountListResponse = array of Account { accountID, bridge, network, user }

Connected accounts the user can act through. Includes accountID and user identity.

accountID: string

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

bridge: object { id, provider, type }

Bridge metadata for the account. Available from Beeper Desktop v.4.2.719+.

id: string

Bridge instance identifier.

provider: "cloud" or "self-hosted" or "local" or "platform-sdk"

Bridge provider for the account.

One of the following:

"cloud"

"self-hosted"

"local"

"platform-sdk"

type: string

Bridge type.

network: string

Human-friendly network name for the account.

user: User { id, cannotMessage, email, 5 more }

User the account belongs to.

id: string

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

cannotMessage: optional 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: optional string

Email address if known. Not guaranteed verified.

fullName: optional string

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

imgURL: optional string

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

isSelf: optional boolean

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

phoneNumber: optional string

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

username: optional string

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

GET/v1/accounts/{accountID}/contacts

List contacts

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

ModelsExpand Collapse

ContactSearchResponse object { items }

items: array of User { id, cannotMessage, email, 5 more }

id: string

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

cannotMessage: optional 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: optional string

Email address if known. Not guaranteed verified.

fullName: optional string

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

imgURL: optional string

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

isSelf: optional boolean

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

phoneNumber: optional string

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

username: optional string

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