List bridge logins

client.Bridges.Logins.List(ctx, bridgeID) (*BridgeLoginListResponse, error)

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.

minLength1

ReturnsExpand Collapse

type BridgeLoginListResponse struct{…}

Items []BridgeLogin

BridgeID string

Bridge ID.

LoginID string

Bridge login ID.

RemoveScopes []string

One of the following:

const BridgeLoginRemoveScopeCurrentDevice BridgeLoginRemoveScope = "current-device"

const BridgeLoginRemoveScopeAllDevices BridgeLoginRemoveScope = "all-devices"

Status BridgeLoginStatus

One of the following:

const BridgeLoginStatusConnected BridgeLoginStatus = "connected"

const BridgeLoginStatusConnecting BridgeLoginStatus = "connecting"

const BridgeLoginStatusNeedsLogin BridgeLoginStatus = "needs_login"

const BridgeLoginStatusLoggedOut BridgeLoginStatus = "logged_out"

const BridgeLoginStatusUnknown BridgeLoginStatus = "unknown"

AccountIDs []stringOptional

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

StatusText stringOptional

Human-friendly bridge login status text.

User UserOptional

User the account belongs to.

ID string

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

CannotMessage boolOptional

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 stringOptional

Email address if known. Not guaranteed verified.

FullName stringOptional

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

ImgURL stringOptional

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 boolOptional

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

PhoneNumber stringOptional

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

Username stringOptional

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

List bridge logins

package main

import (
  "context"
  "fmt"

  "github.com/beeper/desktop-api-go"
  "github.com/beeper/desktop-api-go/option"
)

func main() {
  client := beeperdesktopapi.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  logins, err := client.Bridges.Logins.List(context.TODO(), "local-whatsapp")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", logins.Items)
}

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

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