API Reference

Bridges

Logins

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List bridge logins

$client->bridges->logins->list(string bridgeID): 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

bridgeID: string

Bridge ID.

ReturnsExpand Collapse

LoginListResponse

list<BridgeLogin> items

List bridge logins

PHP

HTTP

TypeScript

Python

Go

PHP

<?php

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

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

$logins = $client->bridges->logins->list('local-whatsapp');

var_dump($logins);

200 example

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

200 example

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