API Reference

Bridges

Login Flows

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List login flows

$ beeper-desktop bridges:login-flows list

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

Bridge ID.

ReturnsExpand Collapse

BridgeLoginFlowListResponse: object { items }

items: array of LoginFlow { id, description, name }

id: string

Flow ID to pass when creating a bridge login session.

description: optional string

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

name: optional string

Display name for the flow, when provided.

List login flows

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

PHP

beeper-desktop bridges:login-flows list \
  --access-token 'My Access Token' \
  --bridge-id local-whatsapp

200 example

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

Returns Examples

200 example

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