## Search

**get** `/v1/chats/search`

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

### Query Parameters

- `accountIDs: optional array of string`

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

- `cursor: optional string`

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

- `direction: optional "after" or "before"`

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

  - `"after"`

  - `"before"`

- `inbox: optional "primary" or "low-priority" or "archive"`

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

  - `"primary"`

  - `"low-priority"`

  - `"archive"`

- `includeMuted: optional boolean`

  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: optional string`

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

- `lastActivityBefore: optional string`

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

- `limit: optional number`

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

- `query: optional string`

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

- `scope: optional "titles" or "participants"`

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

  - `"titles"`

  - `"participants"`

- `type: optional "single" or "group" or "any"`

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

  - `"single"`

  - `"group"`

  - `"any"`

- `unreadOnly: optional boolean`

  Set to true to only retrieve chats that have unread messages

### Returns

- `hasMore: boolean`

  True if additional results can be fetched using the provided cursors.

- `items: array of Chat`

  Chats matching the filters.

  - `id: string`

    Unique identifier of the chat across Beeper.

  - `accountID: string`

    Account ID this chat belongs to.

  - `participants: object { hasMore, items, total }`

    Chat participants information.

    - `hasMore: boolean`

      True if there are more participants than included in items.

    - `items: array of User`

      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: optional 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: optional string`

        Email address if known. Not guaranteed verified.

      - `fullName: optional string`

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

      - `imgURL: optional string`

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

      - `isSelf: optional boolean`

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

      - `phoneNumber: optional string`

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

      - `username: optional 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" or "group"`

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

    - `"single"`

    - `"group"`

  - `unreadCount: number`

    Number of unread messages.

  - `isArchived: optional boolean`

    True if chat is archived.

  - `isMuted: optional boolean`

    True if chat notifications are muted.

  - `isPinned: optional boolean`

    True if chat is pinned.

  - `lastActivity: optional string`

    Timestamp of last activity.

  - `lastReadMessageSortKey: optional string`

    Last read message sortKey.

  - `localChatID: optional string`

    Local chat ID specific to this Beeper Desktop installation.

- `newestCursor: string`

  Cursor for fetching newer results (use with direction='after'). Opaque string; do not inspect.

- `oldestCursor: string`

  Cursor for fetching older results (use with direction='before'). Opaque string; do not inspect.

### Example

```http
curl http://localhost:23373/v1/chats/search
```