API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Accounts

Manage connected chat accounts

List chat accounts

client.accounts.list(RequestOptionsoptions?): AccountListResponse { accountID, bridge, status, 5 more }

GET/v1/accounts

Get chat account

client.accounts.retrieve(stringaccountID, RequestOptionsoptions?): AccountRetrieveResponse { accountID, bridge, status, 5 more }

GET/v1/accounts/{accountID}

ModelsExpand Collapse

Account { accountID, bridge, status, 5 more }

A chat account added to Beeper.

accountID: string

Chat account added to Beeper. Use this to route account-scoped actions. Examples include matrix for Beeper/Matrix, discordgo for a cloud bridge, slackgo.TEAM-USER for workspace-scoped cloud bridges, and local-whatsapp_ba_… for local bridges.

bridge: AccountBridge { id, provider, type }

Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.

id: string

Bridge identifier. Beeper Cloud accounts often use the network type (for example matrix or discordgo); on-device accounts use a local bridge ID (for example local-whatsapp). Available in Beeper Desktop v4.2.785+.

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

Where this account runs: on this device or in Beeper Cloud. Available in Beeper Desktop v4.2.785+.

One of the following:

"cloud"

"self-hosted"

"local"

"platform-sdk"

type: string

Bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, or twitter. Available in Beeper Desktop v4.2.785+.

status: "connected" | "connecting" | "backfilling" | 5 more

Current connection status for this account.

One of the following:

"connected"

"connecting"

"backfilling"

"connection_required"

"reconnect_required"

"attention_required"

"disconnected"

"disabled"

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?: 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. This may be a remote URL, media URL, data URL, or local file URL depending on the source. May be temporary or available only on 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.

capabilities?: Capabilities { allowed_reactions, archive, custom_emoji_reactions, 24 more }

Runtime bridgev2 room feature capabilities for this connected account, when available.

allowed_reactions?: Array<string>

Allowed Unicode reactions. Omitted means all emoji reactions are allowed.

archive?: boolean

True if archive/unarchive is supported.

custom_emoji_reactions?: boolean

True if custom emoji reactions are supported.

delete?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

delete_chat?: boolean

True if deleting chats for the authenticated user is supported.

delete_chat_for_everyone?: boolean

True if deleting chats for everyone is supported.

delete_for_me?: boolean

True if deleting messages only for the authenticated user is supported.

delete_max_age?: number

Maximum message age for delete-for-everyone, in seconds.

disappearing_timer?: DisappearingTimer { omit_empty_timer, timers, types }

Disappearing-message timer capabilities.

omit_empty_timer?: boolean

True if empty timer objects should be omitted from message content.

timers?: Array<number>

Allowed disappearing timer values in milliseconds. Omitted means any timer is allowed.

types?: Array<"after_read" | "after_send">

Supported disappearing timer types.

One of the following:

"after_read"

"after_send"

edit?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

edit_max_age?: number

Maximum message age for edits, in seconds.

edit_max_count?: number

Maximum number of edits allowed for one message.

file?: Record<string, File>

Supported attachment message types and their per-type constraints, keyed by Matrix msgtype or bridgev2 pseudo-msgtype.

mime_types: Record<string, -2 | -1 | 0 | 2 more>

Supported MIME types or MIME patterns for this file message type. Missing MIME types should be treated as rejected.

One of the following:

-2

-1

0

1

2

caption?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

max_caption_length?: number

Maximum caption length when captions are supported.

max_duration?: number

Maximum audio or video duration in seconds.

max_height?: number

Maximum image or video height in pixels.

max_size?: number

Maximum file size in bytes.

max_width?: number

Maximum image or video width in pixels.

view_once?: boolean

True if this file type can be sent as view-once media.

formatting?: Record<string, -2 | -1 | 0 | 2 more>

Supported rich-text formatting features keyed by bridgev2 feature name. Omitted means no formatting support is advertised.

One of the following:

-2

-1

0

1

2

location_message?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

mark_as_unread?: boolean

True if marking chats unread is supported.

max_text_length?: number

Maximum length of normal text messages.

member_actions?: MemberActions { ban, invite, kick, 2 more }

Participant management capabilities.

ban?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

invite?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

kick?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

leave?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

revoke_invite?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

message_request?: MessageRequest { accept_with_button, accept_with_message }

Message request capabilities.

accept_with_button?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

accept_with_message?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

poll?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

reaction?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

reaction_count?: number

Maximum number of reactions allowed on a single message.

read_receipts?: boolean

True if read receipts are supported.

reply?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

state?: State { com.beeper.disappearing_timer, m.room.avatar, m.room.name, m.room.topic }

Room state update capabilities keyed by Matrix state event type.

"com.beeper.disappearing_timer"?: ComBeeperDisappearingTimer { level }

Disappearing-message timer state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.avatar"?: MRoomAvatar { level }

Chat avatar state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.name"?: MRoomName { level }

Chat title state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.topic"?: MRoomTopic { level }

Chat description/topic state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

thread?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

typing_notifications?: boolean

True if typing notifications are supported.

loginID?: string

Bridge login ID for this account, when known. One bridge login can contain multiple chat accounts.

network?: string

Human-friendly network name for the account. Omitted when the network is unknown.

statusText?: string

Human-friendly account status text.

AccountBridge { id, provider, type }

Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.

id: string

Bridge identifier. Beeper Cloud accounts often use the network type (for example matrix or discordgo); on-device accounts use a local bridge ID (for example local-whatsapp). Available in Beeper Desktop v4.2.785+.

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

Where this account runs: on this device or in Beeper Cloud. Available in Beeper Desktop v4.2.785+.

One of the following:

"cloud"

"self-hosted"

"local"

"platform-sdk"

type: string

Bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, or twitter. Available in Beeper Desktop v4.2.785+.

AccountListResponse = Array<Account { accountID, bridge, status, 5 more } >

Chat accounts configured on this device. Includes accountID, bridge metadata, optional network name, and user identity.

accountID: string

Chat account added to Beeper. Use this to route account-scoped actions. Examples include matrix for Beeper/Matrix, discordgo for a cloud bridge, slackgo.TEAM-USER for workspace-scoped cloud bridges, and local-whatsapp_ba_… for local bridges.

bridge: AccountBridge { id, provider, type }

Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.

id: string

Bridge identifier. Beeper Cloud accounts often use the network type (for example matrix or discordgo); on-device accounts use a local bridge ID (for example local-whatsapp). Available in Beeper Desktop v4.2.785+.

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

Where this account runs: on this device or in Beeper Cloud. Available in Beeper Desktop v4.2.785+.

One of the following:

"cloud"

"self-hosted"

"local"

"platform-sdk"

type: string

Bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, or twitter. Available in Beeper Desktop v4.2.785+.

status: "connected" | "connecting" | "backfilling" | 5 more

Current connection status for this account.

One of the following:

"connected"

"connecting"

"backfilling"

"connection_required"

"reconnect_required"

"attention_required"

"disconnected"

"disabled"

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?: 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. This may be a remote URL, media URL, data URL, or local file URL depending on the source. May be temporary or available only on 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.

capabilities?: Capabilities { allowed_reactions, archive, custom_emoji_reactions, 24 more }

Runtime bridgev2 room feature capabilities for this connected account, when available.

allowed_reactions?: Array<string>

Allowed Unicode reactions. Omitted means all emoji reactions are allowed.

archive?: boolean

True if archive/unarchive is supported.

custom_emoji_reactions?: boolean

True if custom emoji reactions are supported.

delete?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

delete_chat?: boolean

True if deleting chats for the authenticated user is supported.

delete_chat_for_everyone?: boolean

True if deleting chats for everyone is supported.

delete_for_me?: boolean

True if deleting messages only for the authenticated user is supported.

delete_max_age?: number

Maximum message age for delete-for-everyone, in seconds.

disappearing_timer?: DisappearingTimer { omit_empty_timer, timers, types }

Disappearing-message timer capabilities.

omit_empty_timer?: boolean

True if empty timer objects should be omitted from message content.

timers?: Array<number>

Allowed disappearing timer values in milliseconds. Omitted means any timer is allowed.

types?: Array<"after_read" | "after_send">

Supported disappearing timer types.

One of the following:

"after_read"

"after_send"

edit?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

edit_max_age?: number

Maximum message age for edits, in seconds.

edit_max_count?: number

Maximum number of edits allowed for one message.

file?: Record<string, File>

Supported attachment message types and their per-type constraints, keyed by Matrix msgtype or bridgev2 pseudo-msgtype.

mime_types: Record<string, -2 | -1 | 0 | 2 more>

Supported MIME types or MIME patterns for this file message type. Missing MIME types should be treated as rejected.

One of the following:

-2

-1

0

1

2

caption?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

max_caption_length?: number

Maximum caption length when captions are supported.

max_duration?: number

Maximum audio or video duration in seconds.

max_height?: number

Maximum image or video height in pixels.

max_size?: number

Maximum file size in bytes.

max_width?: number

Maximum image or video width in pixels.

view_once?: boolean

True if this file type can be sent as view-once media.

formatting?: Record<string, -2 | -1 | 0 | 2 more>

Supported rich-text formatting features keyed by bridgev2 feature name. Omitted means no formatting support is advertised.

One of the following:

-2

-1

0

1

2

location_message?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

mark_as_unread?: boolean

True if marking chats unread is supported.

max_text_length?: number

Maximum length of normal text messages.

member_actions?: MemberActions { ban, invite, kick, 2 more }

Participant management capabilities.

ban?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

invite?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

kick?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

leave?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

revoke_invite?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

message_request?: MessageRequest { accept_with_button, accept_with_message }

Message request capabilities.

accept_with_button?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

accept_with_message?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

poll?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

reaction?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

reaction_count?: number

Maximum number of reactions allowed on a single message.

read_receipts?: boolean

True if read receipts are supported.

reply?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

state?: State { com.beeper.disappearing_timer, m.room.avatar, m.room.name, m.room.topic }

Room state update capabilities keyed by Matrix state event type.

"com.beeper.disappearing_timer"?: ComBeeperDisappearingTimer { level }

Disappearing-message timer state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.avatar"?: MRoomAvatar { level }

Chat avatar state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.name"?: MRoomName { level }

Chat title state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.topic"?: MRoomTopic { level }

Chat description/topic state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

thread?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

typing_notifications?: boolean

True if typing notifications are supported.

loginID?: string

Bridge login ID for this account, when known. One bridge login can contain multiple chat accounts.

network?: string

Human-friendly network name for the account. Omitted when the network is unknown.

statusText?: string

Human-friendly account status text.

AccountRetrieveResponse { accountID, bridge, status, 5 more }

A chat account added to Beeper.

accountID: string

Chat account added to Beeper. Use this to route account-scoped actions. Examples include matrix for Beeper/Matrix, discordgo for a cloud bridge, slackgo.TEAM-USER for workspace-scoped cloud bridges, and local-whatsapp_ba_… for local bridges.

bridge: AccountBridge { id, provider, type }

Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.

id: string

Bridge identifier. Beeper Cloud accounts often use the network type (for example matrix or discordgo); on-device accounts use a local bridge ID (for example local-whatsapp). Available in Beeper Desktop v4.2.785+.

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

Where this account runs: on this device or in Beeper Cloud. Available in Beeper Desktop v4.2.785+.

One of the following:

"cloud"

"self-hosted"

"local"

"platform-sdk"

type: string

Bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, or twitter. Available in Beeper Desktop v4.2.785+.

status: "connected" | "connecting" | "backfilling" | 5 more

Current connection status for this account.

One of the following:

"connected"

"connecting"

"backfilling"

"connection_required"

"reconnect_required"

"attention_required"

"disconnected"

"disabled"

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?: 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. This may be a remote URL, media URL, data URL, or local file URL depending on the source. May be temporary or available only on 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.

capabilities?: Capabilities { allowed_reactions, archive, custom_emoji_reactions, 24 more }

Runtime bridgev2 room feature capabilities for this connected account, when available.

allowed_reactions?: Array<string>

Allowed Unicode reactions. Omitted means all emoji reactions are allowed.

archive?: boolean

True if archive/unarchive is supported.

custom_emoji_reactions?: boolean

True if custom emoji reactions are supported.

delete?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

delete_chat?: boolean

True if deleting chats for the authenticated user is supported.

delete_chat_for_everyone?: boolean

True if deleting chats for everyone is supported.

delete_for_me?: boolean

True if deleting messages only for the authenticated user is supported.

delete_max_age?: number

Maximum message age for delete-for-everyone, in seconds.

disappearing_timer?: DisappearingTimer { omit_empty_timer, timers, types }

Disappearing-message timer capabilities.

omit_empty_timer?: boolean

True if empty timer objects should be omitted from message content.

timers?: Array<number>

Allowed disappearing timer values in milliseconds. Omitted means any timer is allowed.

types?: Array<"after_read" | "after_send">

Supported disappearing timer types.

One of the following:

"after_read"

"after_send"

edit?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

edit_max_age?: number

Maximum message age for edits, in seconds.

edit_max_count?: number

Maximum number of edits allowed for one message.

file?: Record<string, File>

Supported attachment message types and their per-type constraints, keyed by Matrix msgtype or bridgev2 pseudo-msgtype.

mime_types: Record<string, -2 | -1 | 0 | 2 more>

Supported MIME types or MIME patterns for this file message type. Missing MIME types should be treated as rejected.

One of the following:

-2

-1

0

1

2

caption?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

max_caption_length?: number

Maximum caption length when captions are supported.

max_duration?: number

Maximum audio or video duration in seconds.

max_height?: number

Maximum image or video height in pixels.

max_size?: number

Maximum file size in bytes.

max_width?: number

Maximum image or video width in pixels.

view_once?: boolean

True if this file type can be sent as view-once media.

formatting?: Record<string, -2 | -1 | 0 | 2 more>

Supported rich-text formatting features keyed by bridgev2 feature name. Omitted means no formatting support is advertised.

One of the following:

-2

-1

0

1

2

location_message?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

mark_as_unread?: boolean

True if marking chats unread is supported.

max_text_length?: number

Maximum length of normal text messages.

member_actions?: MemberActions { ban, invite, kick, 2 more }

Participant management capabilities.

ban?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

invite?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

kick?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

leave?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

revoke_invite?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

message_request?: MessageRequest { accept_with_button, accept_with_message }

Message request capabilities.

accept_with_button?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

accept_with_message?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

poll?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

reaction?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

reaction_count?: number

Maximum number of reactions allowed on a single message.

read_receipts?: boolean

True if read receipts are supported.

reply?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

state?: State { com.beeper.disappearing_timer, m.room.avatar, m.room.name, m.room.topic }

Room state update capabilities keyed by Matrix state event type.

"com.beeper.disappearing_timer"?: ComBeeperDisappearingTimer { level }

Disappearing-message timer state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.avatar"?: MRoomAvatar { level }

Chat avatar state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.name"?: MRoomName { level }

Chat title state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

"m.room.topic"?: MRoomTopic { level }

Chat description/topic state capability.

level: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

thread?: -2 | -1 | 0 | 2 more

-2: rejected, -1: dropped, 0: unsupported, 1: partially supported, 2: fully supported.

One of the following:

-2

-1

0

1

2

typing_notifications?: boolean

True if typing notifications are supported.

loginID?: string

Bridge login ID for this account, when known. One bridge login can contain multiple chat accounts.

network?: string

Human-friendly network name for the account. Omitted when the network is unknown.

statusText?: string

Human-friendly account status text.

AccountsContacts

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. This may be a remote URL, media URL, data URL, or local file URL depending on the source. May be temporary or available only on 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.