Chats

API Reference

Search

Search chats

search.chats(SearchChatsParams**kwargs) -> SyncCursorSearch[Chat]

get/v1/search/chats

Search chats by title/network or participants using Beeper Desktop's renderer algorithm.

ParametersExpand Collapse

account_ids: Optional[SequenceNotStr[str]]

Provide an array of account IDs to filter chats from specific messaging accounts only

cursor: Optional[str]

Opaque pagination cursor; do not inspect. Use together with 'direction'.

direction: Optional[Literal["after", "before"]]

Pagination direction used with 'cursor': 'before' fetches older results, 'after' fetches newer results. Defaults to 'before' when only 'cursor' is provided.

Accepts one of the following:

"after"

"before"

inbox: Optional[Literal["primary", "low-priority", "archive"]]

Filter by inbox type: "primary" (non-archived, non-low-priority), "low-priority", or "archive". If not specified, shows all chats.

Accepts one of the following:

"primary"

"low-priority"

"archive"

include_muted: Optional[bool]

Include chats marked as Muted by the user, which are usually less important. Default: true. Set to false if the user wants a more refined search.

last_activity_after: Optional[Union[str, datetime]]

Provide an ISO datetime string to only retrieve chats with last activity after this time

formatdate-time

last_activity_before: Optional[Union[str, datetime]]

Provide an ISO datetime string to only retrieve chats with last activity before this time

formatdate-time

limit: Optional[int]

Set the maximum number of chats to retrieve. Valid range: 1-200, default is 50

minimum1

maximum200

query: Optional[str]

Literal token search (non-semantic). Use single words users type (e.g., "dinner"). When multiple words provided, ALL must match. Case-insensitive.

minLength1

scope: Optional[Literal["titles", "participants"]]

Search scope: 'titles' matches title + network; 'participants' matches participant names.

Accepts one of the following:

"titles"

"participants"

type: Optional[Literal["single", "group", "any"]]

Specify the type of chats to retrieve: use "single" for direct messages, "group" for group chats, or "any" to get all types

Accepts one of the following:

"single"

"group"

"any"

unread_only: Optional[bool]

Set to true to only retrieve chats that have unread messages

ReturnsExpand Collapse

class Chat: …

id: str

Unique identifier of the chat (room/thread ID, same as id) across Beeper.

account_id: str

Beeper account ID this chat belongs to.

network: str

Display-only human-readable network name (e.g., 'WhatsApp', 'Messenger').

participants: Participants

Chat participants information.

has_more: bool

True if there are more participants than included in items.

items: List[User]

Participants returned for this chat (limited by the request; may be a subset).

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.

total: int

Total number of participants in the chat.

title: str

Display title of the chat as computed by the client/server.

type: Literal["single", "group"]

Chat type: 'single' for direct messages, 'group' for group chats.

Accepts one of the following:

"single"

"group"

unread_count: int

Number of unread messages.

is_archived: Optional[bool]

True if chat is archived.

is_muted: Optional[bool]

True if chat notifications are muted.

is_pinned: Optional[bool]

True if chat is pinned.

last_activity: Optional[datetime]

Timestamp of last activity. Chats with more recent activity are often more important.

formatdate-time

last_read_message_sort_key: Optional[Union[int, str, null]]

Last read message sortKey (hsOrder). Used to compute 'isUnread'.

Accepts one of the following:

LastReadMessageSortKeyUnionMember0 = int

LastReadMessageSortKeyUnionMember1 = str

local_chat_id: Optional[str]

Local chat ID specific to this Beeper Desktop installation.

Search chats

python

• http
• typescript
• python
• go

from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token="My Access Token",
)
page = client.search.chats()
page = page.items[0]
print(page.id)

200 example

{
  "hasMore": true,
  "items": [
    {
      "id": "!KPFTtZYWuERwib8T702N9IfqiCc:ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc.local-whatsapp.localhost",
      "accountID": "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
      "network": "WhatsApp",
      "participants": {
        "hasMore": false,
        "items": [
          {
            "id": "@kishanbagaria:local-whatsapp.localhost",
            "cannotMessage": false,
            "email": "email",
            "fullName": "Kishan Bagaria",
            "imgURL": "imgURL",
            "isSelf": false,
            "phoneNumber": "+15551112222",
            "username": "username"
          }
        ],
        "total": 2
      },
      "title": "Kishan Bagaria",
      "type": "single",
      "unreadCount": 3,
      "isArchived": false,
      "isMuted": false,
      "isPinned": true,
      "lastActivity": "2025-08-31T19:41:41.000Z",
      "lastReadMessageSortKey": 449706228480,
      "localChatID": "1229391"
    },
    {
      "id": "!nZeX7dh67_RaPnmWGJIjUkV2svE:ba_sXf0adnbr287.local-telegram.localhost",
      "accountID": "local-telegram_ba_sXf0adnbr287_pRup35Tgl-lsIg",
      "network": "Telegram",
      "participants": {
        "hasMore": false,
        "items": [
          {
            "id": "@bradmurray:local-telegram.localhost",
            "cannotMessage": false,
            "email": "email",
            "fullName": "Brad Murray",
            "imgURL": "imgURL",
            "isSelf": false,
            "phoneNumber": "+15553334444",
            "username": "username"
          }
        ],
        "total": 2
      },
      "title": "Brad Murray",
      "type": "single",
      "unreadCount": 0,
      "isArchived": true,
      "isMuted": false,
      "isPinned": false,
      "lastActivity": "2025-08-31T18:05:20.648Z",
      "lastReadMessageSortKey": 449706782720,
      "localChatID": "1229078"
    },
    {
      "id": "!twitter_dm_photomatt:local-twitter.localhost",
      "accountID": "local-twitter_ba_gUU1IHNGo_CsTZLp0vDFUYk9EuE",
      "network": "Twitter/X",
      "participants": {
        "hasMore": false,
        "items": [
          {
            "id": "@photomatt:local-twitter.localhost",
            "cannotMessage": false,
            "email": "email",
            "fullName": "Matt Mullenweg",
            "imgURL": "imgURL",
            "isSelf": false,
            "phoneNumber": "phoneNumber",
            "username": "photomatt"
          }
        ],
        "total": 2
      },
      "title": "Matt Mullenweg",
      "type": "single",
      "unreadCount": 1,
      "isArchived": false,
      "isMuted": true,
      "isPinned": false,
      "lastActivity": "2025-08-31T12:30:15.123Z",
      "lastReadMessageSortKey": 449705982340,
      "localChatID": "1228956"
    }
  ],
  "newestCursor": "1756669301000",
  "oldestCursor": "1756667120648"
}

Returns Examples

200 example

{
  "hasMore": true,
  "items": [
    {
      "id": "!KPFTtZYWuERwib8T702N9IfqiCc:ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc.local-whatsapp.localhost",
      "accountID": "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
      "network": "WhatsApp",
      "participants": {
        "hasMore": false,
        "items": [
          {
            "id": "@kishanbagaria:local-whatsapp.localhost",
            "cannotMessage": false,
            "email": "email",
            "fullName": "Kishan Bagaria",
            "imgURL": "imgURL",
            "isSelf": false,
            "phoneNumber": "+15551112222",
            "username": "username"
          }
        ],
        "total": 2
      },
      "title": "Kishan Bagaria",
      "type": "single",
      "unreadCount": 3,
      "isArchived": false,
      "isMuted": false,
      "isPinned": true,
      "lastActivity": "2025-08-31T19:41:41.000Z",
      "lastReadMessageSortKey": 449706228480,
      "localChatID": "1229391"
    },
    {
      "id": "!nZeX7dh67_RaPnmWGJIjUkV2svE:ba_sXf0adnbr287.local-telegram.localhost",
      "accountID": "local-telegram_ba_sXf0adnbr287_pRup35Tgl-lsIg",
      "network": "Telegram",
      "participants": {
        "hasMore": false,
        "items": [
          {
            "id": "@bradmurray:local-telegram.localhost",
            "cannotMessage": false,
            "email": "email",
            "fullName": "Brad Murray",
            "imgURL": "imgURL",
            "isSelf": false,
            "phoneNumber": "+15553334444",
            "username": "username"
          }
        ],
        "total": 2
      },
      "title": "Brad Murray",
      "type": "single",
      "unreadCount": 0,
      "isArchived": true,
      "isMuted": false,
      "isPinned": false,
      "lastActivity": "2025-08-31T18:05:20.648Z",
      "lastReadMessageSortKey": 449706782720,
      "localChatID": "1229078"
    },
    {
      "id": "!twitter_dm_photomatt:local-twitter.localhost",
      "accountID": "local-twitter_ba_gUU1IHNGo_CsTZLp0vDFUYk9EuE",
      "network": "Twitter/X",
      "participants": {
        "hasMore": false,
        "items": [
          {
            "id": "@photomatt:local-twitter.localhost",
            "cannotMessage": false,
            "email": "email",
            "fullName": "Matt Mullenweg",
            "imgURL": "imgURL",
            "isSelf": false,
            "phoneNumber": "phoneNumber",
            "username": "photomatt"
          }
        ],
        "total": 2
      },
      "title": "Matt Mullenweg",
      "type": "single",
      "unreadCount": 1,
      "isArchived": false,
      "isMuted": true,
      "isPinned": false,
      "lastActivity": "2025-08-31T12:30:15.123Z",
      "lastReadMessageSortKey": 449705982340,
      "localChatID": "1228956"
    }
  ],
  "newestCursor": "1756669301000",
  "oldestCursor": "1756667120648"
}