Skip to main content
GET
/
api
/
search
Search messages
curl --request GET \
  --url http://localhost:8091/api/search \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "results": [
      {
        "message": {
          "id": "<string>",
          "channelId": "<string>",
          "userId": "<string>",
          "content": "<string>",
          "edited": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "threadId": "<string>",
          "user": {
            "id": "<string>",
            "username": "<string>",
            "displayName": "<string>",
            "status": "<string>",
            "bot": true,
            "createdAt": "2023-11-07T05:31:56Z",
            "avatarPath": "<string>"
          },
          "replyCount": 123,
          "reactions": [
            {
              "emoji": "<string>",
              "count": 123,
              "users": [
                "<string>"
              ]
            }
          ],
          "attachments": [
            {
              "id": "<string>",
              "messageId": "<string>",
              "filename": "<string>",
              "storedPath": "<string>",
              "mimeType": "<string>",
              "sizeBytes": 123,
              "createdAt": "2023-11-07T05:31:56Z"
            }
          ]
        },
        "channel": {
          "id": "<string>",
          "name": "<string>",
          "displayName": "<string>",
          "topic": "<string>",
          "isDm": true,
          "isPrivate": true,
          "archived": true,
          "createdBy": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "position": 123,
          "serverId": "<string>",
          "memberCount": 123,
          "groupId": "<string>"
        },
        "headline": "<string>",
        "serverName": "<string>"
      }
    ],
    "hasMore": true
  }
}

Authorizations

​
Authorization
string
header
required

Session token obtained from /api/auth/login or /api/auth/register. Pass as: Authorization: Bearer

Query Parameters

​
q
string
required

Search query string

​
server
string

Filter results to a specific server ID

​
limit
integer
default:25

Maximum number of results to return

Required range: x <= 50
​
offset
integer
default:0

Number of results to skip for pagination

Response

200 - application/json

Search results

​
data
object