Accounts

Manage connected chat accounts

List chat accounts

$client->accounts->list(): AccountListResponse

GET/v1/accounts

Get chat account

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

GET/v1/accounts/{accountID}

ModelsExpand Collapse

Account

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.

AccountBridge

string id

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 provider

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

string type

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

AccountsContacts

Manage contacts on a specific account

Search contacts

$client->accounts->contacts->search(string accountID, string query): ContactSearchResponse

GET/v1/accounts/{accountID}/contacts

List contacts

$client->accounts->contacts->list(string accountID, ?string cursor, ?Direction direction, ?int limit, ?string query): CursorSearch<User>

GET/v1/accounts/{accountID}/contacts/list