List

API Reference

Accounts

List connected accounts

client.Accounts.List(ctx) (*[]Account, error)

get/v1/accounts

Lists chat accounts across networks (WhatsApp, Telegram, Twitter/X, etc.) actively connected to this Beeper Desktop instance

ReturnsExpand Collapse

type AccountListResponse []Account

Connected accounts the user can act through. Includes accountID, network, and user identity.

AccountID string

Chat account added to Beeper. Use this to route account-scoped actions.

Network string

Display-only human-readable network name (e.g., 'WhatsApp', 'Messenger').

User User

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. May be temporary or local-only to 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 connected accounts

go

• http
• typescript
• python
• 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"),
  )
  accounts, err := client.Accounts.List(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", accounts)
}

200 example

[
  {
    "accountID": "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
    "network": "WhatsApp",
    "user": {
      "id": "ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
      "cannotMessage": true,
      "email": "email",
      "fullName": "Batuhan İçöz",
      "imgURL": "file:///Users/batuhan/Library/Application%20Support/BeeperTexts/local-whatsapp/attachments/113988c2e1d3d59d0171dcd034ca481eb040a3f9c0435c158e584adb4b59dd59",
      "isSelf": true,
      "phoneNumber": "+15551234567",
      "username": "username"
    }
  },
  {
    "accountID": "local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI",
    "network": "Telegram",
    "user": {
      "id": "ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI",
      "cannotMessage": true,
      "email": "email",
      "fullName": "Batuhan İçöz",
      "imgURL": "file:///Users/batuhan/Library/Application%20Support/BeeperTexts/local-telegram/attachments/e692d0072966c9153e2eb104aca3b8e5c96d869a458d16180a2d62898a935a84",
      "isSelf": true,
      "phoneNumber": "+15559876543",
      "username": "batuhan"
    }
  },
  {
    "accountID": "local-twitter_ba_gUU1IHNGo_CsTZLp0vDFUYk9EuE",
    "network": "Twitter/X",
    "user": {
      "id": "ba_gUU1IHNGo_CsTZLp0vDFUYk9EuE",
      "cannotMessage": true,
      "email": "email",
      "fullName": "Batuhan İçöz",
      "imgURL": "file:///Users/batuhan/Library/Application%20Support/BeeperTexts/local-twitter/attachments/d68c58266f4529493f2e34079dfa15648abd9ffff3a40ea8bc99ac283353eb53",
      "isSelf": true,
      "phoneNumber": "phoneNumber",
      "username": "batuhan"
    }
  }
]

Returns Examples

200 example

[
  {
    "accountID": "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
    "network": "WhatsApp",
    "user": {
      "id": "ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
      "cannotMessage": true,
      "email": "email",
      "fullName": "Batuhan İçöz",
      "imgURL": "file:///Users/batuhan/Library/Application%20Support/BeeperTexts/local-whatsapp/attachments/113988c2e1d3d59d0171dcd034ca481eb040a3f9c0435c158e584adb4b59dd59",
      "isSelf": true,
      "phoneNumber": "+15551234567",
      "username": "username"
    }
  },
  {
    "accountID": "local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI",
    "network": "Telegram",
    "user": {
      "id": "ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI",
      "cannotMessage": true,
      "email": "email",
      "fullName": "Batuhan İçöz",
      "imgURL": "file:///Users/batuhan/Library/Application%20Support/BeeperTexts/local-telegram/attachments/e692d0072966c9153e2eb104aca3b8e5c96d869a458d16180a2d62898a935a84",
      "isSelf": true,
      "phoneNumber": "+15559876543",
      "username": "batuhan"
    }
  },
  {
    "accountID": "local-twitter_ba_gUU1IHNGo_CsTZLp0vDFUYk9EuE",
    "network": "Twitter/X",
    "user": {
      "id": "ba_gUU1IHNGo_CsTZLp0vDFUYk9EuE",
      "cannotMessage": true,
      "email": "email",
      "fullName": "Batuhan İçöz",
      "imgURL": "file:///Users/batuhan/Library/Application%20Support/BeeperTexts/local-twitter/attachments/d68c58266f4529493f2e34079dfa15648abd9ffff3a40ea8bc99ac283353eb53",
      "isSelf": true,
      "phoneNumber": "phoneNumber",
      "username": "batuhan"
    }
  }
]