Contacts

API Reference

Search

Search contacts

search.contacts(straccount_id, SearchContactsParams**kwargs) -> SearchContactsResponse

get/v1/search/contacts/{accountID}

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

ParametersExpand Collapse

account_id: str

Account ID this resource belongs to.

query: str

Text to search users by. Network-specific behavior.

minLength1

ReturnsExpand Collapse

class SearchContactsResponse: …

items: List[User]

id: str

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

cannot_message: Optional[bool]

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: Optional[str]

Email address if known. Not guaranteed verified.

full_name: Optional[str]

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

img_url: Optional[str]

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

is_self: Optional[bool]

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

phone_number: Optional[str]

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

username: Optional[str]

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

Search contacts

python

• http
• typescript
• python
• go

from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token="My Access Token",
)
response = client.search.contacts(
    account_id="local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
    query="x",
)
print(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"
    }
  ]
}