## Get bridge

`client.Bridges.Get(ctx, bridgeID) (*BridgeGetResponse, error)`

**get** `/v1/bridges/{bridgeID}`

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

### Parameters

- `bridgeID string`

  Bridge ID.

### Returns

- `type BridgeGetResponse struct{…}`

  Available bridge that can connect or reconnect chat accounts.

  - `ID string`

    Bridge ID. Use with bridge endpoints.

  - `Accounts []Account`

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

    - `AccountID string`

      Chat account added to Beeper. Use this to route account-scoped actions. Examples include matrix for Beeper/Matrix, discordgo for a cloud bridge, slackgo.TEAM-USER for workspace-scoped cloud bridges, and local-whatsapp_ba_... for local bridges.

    - `Bridge AccountBridge`

      Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.

      - `ID string`

        Bridge identifier. Beeper Cloud accounts often use the network type (for example matrix or discordgo); on-device accounts use a local bridge ID (for example local-whatsapp). Available in Beeper Desktop v4.2.785+.

      - `Provider AccountBridgeProvider`

        Where this account runs: on this device or in Beeper Cloud. Available in Beeper Desktop v4.2.785+.

        - `const AccountBridgeProviderCloud AccountBridgeProvider = "cloud"`

        - `const AccountBridgeProviderSelfHosted AccountBridgeProvider = "self-hosted"`

        - `const AccountBridgeProviderLocal AccountBridgeProvider = "local"`

        - `const AccountBridgeProviderPlatformSDK AccountBridgeProvider = "platform-sdk"`

      - `Type string`

        Bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, or twitter. Available in Beeper Desktop v4.2.785+.

    - `Status AccountStatus`

      Current connection status for this account.

      - `const AccountStatusConnected AccountStatus = "connected"`

      - `const AccountStatusConnecting AccountStatus = "connecting"`

      - `const AccountStatusBackfilling AccountStatus = "backfilling"`

      - `const AccountStatusConnectionRequired AccountStatus = "connection_required"`

      - `const AccountStatusReconnectRequired AccountStatus = "reconnect_required"`

      - `const AccountStatusAttentionRequired AccountStatus = "attention_required"`

      - `const AccountStatusDisconnected AccountStatus = "disconnected"`

      - `const AccountStatusDisabled AccountStatus = "disabled"`

    - `User User`

      User the account belongs to.

      - `ID string`

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

      - `CannotMessage bool`

        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 bool`

        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.

    - `Capabilities map[string, any]`

      Runtime chat/message capabilities for this connected account, when available.

    - `LoginID string`

      Bridge login ID for this account, when known. One bridge login can contain multiple chat accounts.

    - `Network string`

      Human-friendly network name for the account. Omitted when the network is unknown.

    - `StatusText string`

      Human-friendly account status text.

  - `ActiveAccountCount int64`

    Number of active accounts for this network on this device.

  - `DisplayName string`

    Human-friendly bridge name shown in Beeper.

  - `Provider BridgeGetResponseProvider`

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

    - `const BridgeGetResponseProviderCloud BridgeGetResponseProvider = "cloud"`

    - `const BridgeGetResponseProviderSelfHosted BridgeGetResponseProvider = "self-hosted"`

    - `const BridgeGetResponseProviderLocal BridgeGetResponseProvider = "local"`

    - `const BridgeGetResponseProviderPlatformSDK BridgeGetResponseProvider = "platform-sdk"`

  - `Status BridgeGetResponseStatus`

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

    - `const BridgeGetResponseStatusAvailable BridgeGetResponseStatus = "available"`

    - `const BridgeGetResponseStatusConnected BridgeGetResponseStatus = "connected"`

    - `const BridgeGetResponseStatusLimitReached BridgeGetResponseStatus = "limit_reached"`

    - `const BridgeGetResponseStatusTemporarilyUnavailable BridgeGetResponseStatus = "temporarily_unavailable"`

    - `const BridgeGetResponseStatusDisabled BridgeGetResponseStatus = "disabled"`

  - `SupportsMultipleAccounts bool`

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

  - `Type string`

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

  - `Network string`

    Network grouping used for account counts and limits.

  - `StatusText string`

    Human-friendly status text matching Beeper account management language.

### Example

```go
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"),
  )
  bridge, err := client.Bridges.Get(context.TODO(), "local-whatsapp")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", bridge.ID)
}
```

#### Response

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