Search

API Reference

Chats

Search chats

client.chats.search(?, ?): CursorSearch<Chat { id, accountID, network, 10 more } >

get/v1/chats/search

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

ParametersExpand Collapse

query: ChatSearchParams { accountIDs, cursor, direction, 9 more }

accountIDs?: Array<string>

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

cursor?: string

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

direction?: "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?: "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"

includeMuted?: boolean | null

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.

lastActivityAfter?: string

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

formatdate-time

lastActivityBefore?: string

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

formatdate-time

limit?: number

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

minimum1

maximum200

query?: string

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

minLength1

scope?: "titles" | "participants"

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

Accepts one of the following:

"titles"

"participants"

type?: "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"

unreadOnly?: boolean | null

Set to true to only retrieve chats that have unread messages

ReturnsExpand Collapse

Chat { id, accountID, network, 10 more }

id: string

Unique identifier of the chat across Beeper.

accountID: string

Account ID this chat belongs to.

Deprecatednetwork: string

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

participants: Participants { hasMore, items, total }

Chat participants information.

hasMore: boolean

True if there are more participants than included in items.

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

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

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.

total: number

Total number of participants in the chat.

title: string

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

type: "single" | "group"

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

Accepts one of the following:

"single"

"group"

unreadCount: number

Number of unread messages.

isArchived?: boolean

True if chat is archived.

isMuted?: boolean

True if chat notifications are muted.

isPinned?: boolean

True if chat is pinned.

lastActivity?: string

Timestamp of last activity.

formatdate-time

lastReadMessageSortKey?: string

Last read message sortKey.

localChatID?: string | null

Local chat ID specific to this Beeper Desktop installation.

Search chats

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

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

// Automatically fetches more pages as needed.
for await (const chat of client.chats.search()) {
  console.log(chat.id);
}

{
  "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": "eyJ0cyI6MTc1NjY2OTMwMTAwMCwiaWQiOiIhblplWDdkZDY3X1JhUG5tV0dKSWpVa1Yyc3ZFOmJhX3NYZjBhZG5icjI4Ny5sb2NhbC10ZWxlZ3JhbS5sb2NhbGhvc3QiLCJzY29yZSI6MTAuNX0=",
  "oldestCursor": "eyJ0cyI6MTc1NjY2NzEyMDY0OCwiaWQiOiIhS1BGVHRaWVd1RVJ3aWI4VDcwMjlOSWZxaUNjOmJhX0V2WURCQnNamlFSd0F5M1VPU1dxRzBMdVRWa2MiLCJzY29yZSI6MTJ9"
}

Returns Examples

{
  "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": "eyJ0cyI6MTc1NjY2OTMwMTAwMCwiaWQiOiIhblplWDdkZDY3X1JhUG5tV0dKSWpVa1Yyc3ZFOmJhX3NYZjBhZG5icjI4Ny5sb2NhbC10ZWxlZ3JhbS5sb2NhbGhvc3QiLCJzY29yZSI6MTAuNX0=",
  "oldestCursor": "eyJ0cyI6MTc1NjY2NzEyMDY0OCwiaWQiOiIhS1BGVHRaWVd1RVJ3aWI4VDcwMjlOSWZxaUNjOmJhX0V2WURCQnNamlFSd0F5M1VPU1dxRzBMdVRWa2MiLCJzY29yZSI6MTJ9"
}