Search

API Reference

Accounts

Contacts

Search contacts

client.accounts.contacts.search(stringaccountID, ContactSearchParams { query } query, RequestOptionsoptions?): ContactSearchResponse { items }

get/v1/accounts/{accountID}/contacts

Search contacts across on a specific account using the network's search API. Only use for creating new chats.

ParametersExpand Collapse

accountID: string

Account ID this resource belongs to.

query: ContactSearchParams { query }

query: string

Text to search users by. Network-specific behavior.

minLength1

ReturnsExpand Collapse

ContactSearchResponse { items }

items: Array<User { id, cannotMessage, email, 5 more } >

id: string

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

cannotMessage?: boolean

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?: string

Email address if known. Not guaranteed verified.

fullName?: string

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

imgURL?: string

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

isSelf?: boolean

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

phoneNumber?: string

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

username?: string

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

Search contacts

typescript

• http
• typescript
• python
• go

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

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

const response = await client.accounts.contacts.search('accountID', { query: 'x' });

console.log(response.items);

200 example

{
  "items": [
    {
      "id": "id",
      "cannotMessage": true,
      "email": "email",
      "fullName": "fullName",
      "imgURL": "imgURL",
      "isSelf": true,
      "phoneNumber": "phoneNumber",
      "username": "username"
    }
  ]
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "cannotMessage": true,
      "email": "email",
      "fullName": "fullName",
      "imgURL": "imgURL",
      "isSelf": true,
      "phoneNumber": "phoneNumber",
      "username": "username"
    }
  ]
}