API Reference

Bridges

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get bridge

$client->bridges->retrieve(string bridgeID): BridgeGetResponse

GET/v1/bridges/{bridgeID}

Get one bridge, including the chat accounts connected through it.

ParametersExpand Collapse

bridgeID: string

Bridge ID.

ReturnsExpand Collapse

BridgeGetResponse

string id

Bridge ID. Use with bridge endpoints.

list<Account> accounts

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

int activeAccountCount

Number of active accounts for this network on this device.

string displayName

Human-friendly bridge name shown in Beeper.

Provider provider

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

Status status

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

bool supportsMultipleAccounts

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

string type

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

?string network

Network grouping used for account counts and limits.

?string statusText

Human-friendly status text matching Beeper account management language.

Get bridge

PHP

HTTP

TypeScript

Python

Go

CLI Tool

PHP

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(accessToken: 'My Access Token');

$bridge = $client->bridges->retrieve('local-whatsapp');

var_dump($bridge);

200 example

{
  "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

200 example

{
  "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"
}