Skip to content
Beeper Developer Docs
Download Beeper
API Reference
Bridges

List available bridges

bridges.list() -> BridgeListResponse
GET/v1/bridges

List available bridges. A bridge is a chat-network connector that can connect or reconnect chat accounts. Connected accounts use the same Account schema as GET /v1/accounts.

ReturnsExpand Collapse
class BridgeListResponse: …

Available bridges and their connected accounts.

items: List[Bridge]
id: str

Bridge ID. Use with bridge endpoints.

accounts: List[Account]

Connected accounts for this bridge. Uses the same Account schema as GET /v1/accounts.

account_id: str

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

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

id: str

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: Literal["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: str

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

status: Literal["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

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. 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.

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.

capabilities: Optional[Dict[str, Optional[object]]]

Runtime chat/message capabilities for this connected account, when available.

login_id: Optional[str]

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

network: Optional[str]

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

status_text: Optional[str]

Human-friendly account status text.

active_account_count: int

Number of active accounts for this network on this device.

minimum0
display_name: str

Human-friendly bridge name shown in Beeper.

provider: Literal["cloud", "self-hosted", "local", "platform-sdk"]

Where accounts for this bridge run: on this device or in Beeper Cloud.

One of the following:
"cloud"
"self-hosted"
"local"
"platform-sdk"
status: Literal["available", "connected", "limit_reached", 2 more]

Whether this bridge can currently be used to connect new accounts.

One of the following:
"available"
"connected"
"limit_reached"
"temporarily_unavailable"
"disabled"
supports_multiple_accounts: bool

Whether this bridge can have multiple active accounts for the same network.

type: str

Underlying bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, or twitter.

network: Optional[str]

Network grouping used for account counts and limits.

status_text: Optional[str]

Human-friendly status text matching Beeper account management language.

List available bridges

import os
from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
)
bridges = client.bridges.list()
print(bridges.items)
{
  "items": [
    {
      "id": "id",
      "accounts": [
        {
          "accountID": "accountID",
          "bridge": {
            "id": "id",
            "provider": "cloud",
            "type": "type"
          },
          "status": "connected",
          "user": {
            "id": "id",
            "cannotMessage": true,
            "email": "email",
            "fullName": "fullName",
            "imgURL": "imgURL",
            "isSelf": true,
            "phoneNumber": "phoneNumber",
            "username": "username"
          },
          "capabilities": {
            "foo": "bar"
          },
          "loginID": "loginID",
          "network": "network",
          "statusText": "statusText"
        }
      ],
      "activeAccountCount": 0,
      "displayName": "displayName",
      "provider": "cloud",
      "status": "available",
      "supportsMultipleAccounts": true,
      "type": "type",
      "network": "network",
      "statusText": "statusText"
    }
  ]
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "accounts": [
        {
          "accountID": "accountID",
          "bridge": {
            "id": "id",
            "provider": "cloud",
            "type": "type"
          },
          "status": "connected",
          "user": {
            "id": "id",
            "cannotMessage": true,
            "email": "email",
            "fullName": "fullName",
            "imgURL": "imgURL",
            "isSelf": true,
            "phoneNumber": "phoneNumber",
            "username": "username"
          },
          "capabilities": {
            "foo": "bar"
          },
          "loginID": "loginID",
          "network": "network",
          "statusText": "statusText"
        }
      ],
      "activeAccountCount": 0,
      "displayName": "displayName",
      "provider": "cloud",
      "status": "available",
      "supportsMultipleAccounts": true,
      "type": "type",
      "network": "network",
      "statusText": "statusText"
    }
  ]
}