List

API Reference

Accounts

List connected accounts

client.accounts.list(?): AccountListResponse

get/v0/get-accounts

List connected Beeper accounts available on this device

ReturnsExpand Collapse

AccountListResponse = Array<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'). You MUST use 'accountID' to perform actions.

user: User

A person on or reachable through Beeper. Values are best-effort and can vary by network.

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

const client = new BeeperDesktop({
  accessToken: 'My Access Token',
});

const accounts = await client.accounts.list();

console.log(accounts);

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

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