Get bridge login

client.bridges.logins.retrieve(, , ?): BridgeLogin { bridgeID, loginID, removeScopes, 4 more }

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

Get one bridge login.

ParametersExpand Collapse

loginID: string

Bridge login ID.

minLength1

params: LoginRetrieveParams { bridgeID }

bridgeID: string

Bridge ID.

minLength1

ReturnsExpand Collapse

BridgeLogin { bridgeID, loginID, removeScopes, 4 more }

Signed-in identity for a bridge. One bridge login can contain multiple chat accounts.

bridgeID: string

Bridge ID.

loginID: string

Bridge login ID.

removeScopes: Array<"current-device" | "all-devices">

One of the following:

"current-device"

"all-devices"

status: "connected" | "connecting" | "needs_login" | 2 more

One of the following:

"connected"

"connecting"

"needs_login"

"logged_out"

"unknown"

accountIDs?: Array<string>

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

statusText?: string

Human-friendly bridge login status text.

user?: User { id, cannotMessage, email, 5 more }

User the account belongs to.

id: string

Stable Beeper user ID. Use as the primary key when referencing a person.

cannotMessage?: boolean

True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.

email?: string

Email address if known. Not guaranteed verified.

fullName?: string

Display name as shown in clients (e.g., ‘Alice Example’). May include emojis.

imgURL?: string

Avatar image URL if available. This may be a remote URL, media URL, data URL, or local file URL depending on the source. May be temporary or available only on this device; download promptly if durable access is needed.

isSelf?: boolean

True if this user represents the authenticated account’s own identity.

phoneNumber?: string

User’s phone number in E.164 format (e.g., ‘+14155552671’). Omit if unknown.

username?: string

Human-readable handle if available (e.g., ‘@alice’). May be network-specific and not globally unique.

Get bridge login

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: process.env['BEEPER_ACCESS_TOKEN'], // This is the default and can be omitted
});

const bridgeLogin = await client.bridges.logins.retrieve('ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc', {
  bridgeID: 'local-whatsapp',
});

console.log(bridgeLogin.bridgeID);

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

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