Get search suggestions for pages, users, or groups

6 body fields

Autocomplete search criteria and options for selecting suggestion categories.

includeGroupsbooleanoptional

If `true`, includes matching groups in the suggestions.

includePagesbooleanoptional

If `true`, includes matching pages in the suggestions.

includeUsersbooleanoptional

If `true`, includes matching users in the suggestions.

limitintegeroptional

Maximum number of suggestions per category.

querystringrequired

Search query for autocomplete suggestions.

spaceIdstringoptional

Restrict page suggestions to a specific space.

2 status codes

200Returns suggestions grouped by type.

dataobjectoptional

statusintegeroptional

successbooleanoptional

401Returned when the request is unauthorized.

errorstringoptional

Reason phrase, for example `Bad Request`.

messagestringoptional

statusCodeintegeroptional

Error handling

query is required. A 401 is returned when the request is not authorized.

import { DocmostAPIUnofficialOctriFullPreview } from "docmost-octri-preview-sdk";

const client = new DocmostAPIUnofficialOctriFullPreview({
  baseUrl: "{baseUrl}/api",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.search.suggestions({ query: "keyword" });

{
  "data": {
    "groups": [
      {
        "description": "Example description",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name"
      }
    ],
    "pages": [
      {
        "icon": "example_value",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "slugId": "550e8400-e29b-41d4-a716-446655440000",
        "spaceId": "550e8400-e29b-41d4-a716-446655440000",
        "title": "Example Title"
      }
    ],
    "users": [
      {
        "avatarUrl": "https://example.com",
        "email": "user@example.com",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name"
      }
    ]
  },
  "status": 200,
  "success": true
}

Request

Response

Errors