List connected accounts

Deprecated

GET

/v0/get-accounts

• Beeper Desktop API server

List connected Beeper accounts available on this device. Use GET /v1/accounts instead.

Responses

200

Tool executed successfully

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

Array<object>

A chat account added to Beeper

object

accountID

required

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

string

network

required

Display-only human-readable network name (e.g., ‘WhatsApp’, ‘Messenger’). You MUST use ‘accountID’ to perform actions.

string

Example

WhatsApp

user

required

object

id

required

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

string

username

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

string

phoneNumber

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

string

email

Email address if known. Not guaranteed verified.

string

fullName

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

string

imgURL

Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.

string

cannotMessage

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

boolean

isSelf

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

boolean

Example

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

400

Invalid request parameters

object

error

required

Error message

string

code

Error code

string

details

Additional error details

object

key

additional properties

string

401

Access token is missing or invalid

object

error

required

Error message

string

code

Error code

string

details

Additional error details

object

key

additional properties

string

403

Access token does not have the required scope

object

error

required

Error message

string

code

Error code

string

details

Additional error details

object

key

additional properties

string

404

Resource not found

object

error

required

Error message

string

code

Error code

string

details

Additional error details

object

key

additional properties

string

422

Unprocessable entity - validation error

object

error

required

Error message

string

code

Error code

string

details

Additional error details

object

key

additional properties

string

429

Too many requests - rate limit exceeded

object

error

required

Error message

string

code

Error code

string

details

Additional error details

object

key

additional properties

string

500

Internal server error

object

error

required

Error message

string

code

Error code

string

details

Additional error details

object

key

additional properties

string