API Reference

Accounts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get chat account

$client->accounts->retrieve(string accountID): AccountGetResponse

GET/v1/accounts/{accountID}

Get one chat account connected to this Beeper Client API server.

ParametersExpand Collapse

accountID: string

Account ID this resource belongs to.

ReturnsExpand Collapse

AccountGetResponse

string accountID

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.

AccountBridge bridge

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

Status status

Current connection status for this account.

User user

User the account belongs to.

?array<string,mixed> capabilities

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

?string loginID

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

?string network

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

?string statusText

Human-friendly account status text.

Get chat account

PHP

HTTP

TypeScript

Python

Go

CLI Tool

PHP

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(accessToken: 'My Access Token');

$account = $client->accounts->retrieve('accountID');

var_dump($account);

200 example

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

Returns Examples

200 example

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