List bridge logins

bridges.logins.list() -> LoginListResponse

GET/v1/bridges/{bridgeID}/logins

List bridge logins. A bridge login is a signed-in identity for a bridge and can contain one or more chat accounts.

ParametersExpand Collapse

bridge_id: str

Bridge ID.

minLength1

ReturnsExpand Collapse

class LoginListResponse: …

items: List[BridgeLogin]

bridge_id: str

Bridge ID.

login_id: str

Bridge login ID.

remove_scopes: List[Literal["current-device", "all-devices"]]

One of the following:

"current-device"

"all-devices"

status: Literal["connected", "connecting", "needs_login", 2 more]

One of the following:

"connected"

"connecting"

"needs_login"

"logged_out"

"unknown"

account_ids: Optional[List[str]]

Chat accounts that belong to this bridge login, when known.

status_text: Optional[str]

Human-friendly bridge login status text.

user: Optional[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.

List bridge logins

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
)
logins = client.bridges.logins.list(
    "local-whatsapp",
)
print(logins.items)

{
  "items": [
    {
      "bridgeID": "bridgeID",
      "loginID": "loginID",
      "removeScopes": [
        "current-device"
      ],
      "status": "connected",
      "accountIDs": [
        "string"
      ],
      "statusText": "statusText",
      "user": {
        "id": "id",
        "cannotMessage": true,
        "email": "email",
        "fullName": "fullName",
        "imgURL": "imgURL",
        "isSelf": true,
        "phoneNumber": "phoneNumber",
        "username": "username"
      }
    }
  ]
}

Returns Examples

{
  "items": [
    {
      "bridgeID": "bridgeID",
      "loginID": "loginID",
      "removeScopes": [
        "current-device"
      ],
      "status": "connected",
      "accountIDs": [
        "string"
      ],
      "statusText": "statusText",
      "user": {
        "id": "id",
        "cannotMessage": true,
        "email": "email",
        "fullName": "fullName",
        "imgURL": "imgURL",
        "isSelf": true,
        "phoneNumber": "phoneNumber",
        "username": "username"
      }
    }
  ]
}