v10

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-02-242335121.2 KB
App

Search

Returns matching chats, participant name matches in groups, and the first page of messages in one call. Paginate messages via search-messages. Paginate chats via search-chats.

get/v1/search

Query parameters

querystring required

User-typed search text. Literal word matching (non-semantic).

User-typed search text. Literal word matching (non-semantic).

Response

Request executed successfully

Example response

{
  "results": {
    "chats": [
      {
        "id": "!instagram_mattwondra:local-instagram.localhost",
        "localChatID": "1229391",
        "accountID": "local-instagram_ba_eRfQMmnSNy_p7Ih7HL7RduRpKFU",
        "title": "Matt Wondra",
        "type": "single",
        "participants": {
          "items": [
            {
              "id": "@mattwondra:local-instagram.localhost",
              "username": "mattwondra",
              "fullName": "Matt Wondra",
              "cannotMessage": false,
              "isSelf": false
            },
            {
              "id": "@batuhan:local-instagram.localhost",
              "username": "batuhan",
              "fullName": "Batuhan İçöz",
              "cannotMessage": false,
              "isSelf": true
            }
          ],
          "hasMore": false,
          "total": 2
        },
        "lastActivity": "2025-08-31T19:41:41.000Z",
        "unreadCount": 0,
        "lastReadMessageSortKey": "449706228480",
        "isArchived": false,
        "isMuted": false,
        "isPinned": false
      }
    ],
    "in_groups": [
      {
        "id": "!instagram_mattwondra:local-instagram.localhost",
        "localChatID": "1229391",
        "accountID": "local-instagram_ba_eRfQMmnSNy_p7Ih7HL7RduRpKFU",
        "title": "Matt Wondra",
        "type": "single",
        "participants": {
          "items": [
            {
              "id": "@mattwondra:local-instagram.localhost",
              "username": "mattwondra",
              "fullName": "Matt Wondra",
              "cannotMessage": false,
              "isSelf": false
            },
            {
              "id": "@batuhan:local-instagram.localhost",
              "username": "batuhan",
              "fullName": "Batuhan İçöz",
              "cannotMessage": false,
              "isSelf": true
            }
          ],
          "hasMore": false,
          "total": 2
        },
        "lastActivity": "2025-08-31T19:41:41.000Z",
        "unreadCount": 0,
        "lastReadMessageSortKey": "449706228480",
        "isArchived": false,
        "isMuted": false,
        "isPinned": false
      }
    ],
    "messages": {
      "items": [
        {
          "id": "1343993",
          "chatID": "!signal_adamvy:local-signal.localhost",
          "accountID": "local-signal_ba_7N74FrU29pxij_TnqfxeUHj53FY",
          "senderID": "@adamvy:local-signal.localhost",
          "senderName": "Adam Van Ymeren",
          "timestamp": "2025-08-28T11:04:29.621Z",
          "sortKey": "aaaa1",
          "text": "Hey, can we reschedule our meeting to 3pm?",
          "isSender": false,
          "isUnread": false
        },
        {
          "id": "1343994",
          "chatID": "!telegram_nick:local-telegram.localhost",
          "accountID": "local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI",
          "senderID": "@nick:local-telegram.localhost",
          "senderName": "Nick Mills-Barrett",
          "timestamp": "2025-08-28T14:22:15.432Z",
          "sortKey": "aaaa2",
          "text": "The deployment is complete, everything looks good",
          "isSender": false,
          "isUnread": true
        }
      ],
      "chats": {
        "!signal_adamvy:local-signal.localhost": {
          "id": "!signal_adamvy:local-signal.localhost",
          "localChatID": "1229720",
          "accountID": "local-signal_ba_7N74FrU29pxij_TnqfxeUHj53FY",
          "title": "Adam Van Ymeren",
          "type": "single",
          "participants": {
            "items": [
              {
                "id": "@adamvy:local-signal.localhost",
                "fullName": "Adam Van Ymeren",
                "cannotMessage": false,
                "isSelf": false
              },
              {
                "id": "@batuhan:local-signal.localhost",
                "fullName": "Batuhan İçöz",
                "cannotMessage": false,
                "isSelf": true
              }
            ],
            "hasMore": false,
            "total": 2
          },
          "lastActivity": "2025-08-31T17:38:20.393Z",
          "unreadCount": 0,
          "isArchived": false,
          "isMuted": false,
          "isPinned": true
        },
        "!telegram_nick:local-telegram.localhost": {
          "id": "!telegram_nick:local-telegram.localhost",
          "localChatID": "1229721",
          "accountID": "local-telegram_ba_QFrb5lrLPhO3OT5MFBeTWv0x4BI",
          "title": "Nick Mills-Barrett",
          "type": "single",
          "participants": {
            "items": [
              {
                "id": "@nick:local-telegram.localhost",
                "username": "nick",
                "fullName": "Nick Mills-Barrett",
                "cannotMessage": false,
                "isSelf": false
              },
              {
                "id": "@batuhan:local-telegram.localhost",
                "username": "batuhan",
                "fullName": "Batuhan İçöz",
                "cannotMessage": false,
                "isSelf": true
              }
            ],
            "hasMore": false,
            "total": 2
          },
          "lastActivity": "2025-08-31T16:45:10.123Z",
          "unreadCount": 2,
          "isArchived": false,
          "isMuted": true,
          "isPinned": false
        }
      },
      "hasMore": true,
      "oldestCursor": "1756379069621",
      "newestCursor": null
    }
  }
}