API Reference

Bridges

Login Flows

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List login flows

bridges.login_flows.list(strbridge_id) -> LoginFlowListResponse

GET/v1/bridges/{bridgeID}/login-flows

List connect and reconnect flow options for a bridge. Use a flowID when creating a bridge login session.

ParametersExpand Collapse

bridge_id: str

Bridge ID.

minLength1

ReturnsExpand Collapse

class LoginFlowListResponse: …

items: List[LoginFlow]

id: str

Flow ID to pass when creating a bridge login session.

description: Optional[str]

Short explanation for when to use this flow, when provided.

name: Optional[str]

Display name for the flow, when provided.

List login flows

Python

HTTP

TypeScript

Python

Go

CLI Tool

PHP

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

200 example

{
  "items": [
    {
      "id": "id",
      "description": "description",
      "name": "name"
    }
  ]
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "description": "description",
      "name": "name"
    }
  ]
}