API Reference

Bridges

Logins

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get bridge login

$client->bridges->logins->retrieve(string loginID, string bridgeID): BridgeLogin

GET/v1/bridges/{bridgeID}/logins/{loginID}

Get one bridge login.

ParametersExpand Collapse

bridgeID: string

Bridge ID.

loginID: string

Bridge login ID.

ReturnsExpand Collapse

BridgeLogin

string bridgeID

Bridge ID.

string loginID

Bridge login ID.

list<RemoveScope> removeScopes

Status status

?list<string> accountIDs

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

?string statusText

Human-friendly bridge login status text.

?User user

User the account belongs to.

Get bridge login

PHP

HTTP

TypeScript

Python

Go

PHP

<?php

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

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

$bridgeLogin = $client->bridges->logins->retrieve(
  'ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc', bridgeID: 'local-whatsapp'
);

var_dump($bridgeLogin);

200 example

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

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