ДескусДескус · Документация
Все разделыСправочник · База знаний

GET /kb/articles/search — поиск

Поиск по статьям — тот же, что в справочном центре компании. Подойдёт для своего виджета помощи или подсказок оператору в CRM. Право — kb:read.

Запрос

curl "https://app.deskus.ru/api/v1/kb/articles/search?q=вернуть%20зёрна&limit=5" \
  -H "Authorization: Bearer $DESKUS_KEY"

Ответ 200

{
  "data": [
    {
      "id": "9d2f6b1c-3e8a-4f7d-a2c5-6b0e1d9f4a87",
      "title": "Как вернуть зёрна",
      "summary": "Вернуть нераспечатанную пачку можно в течение 14 дней.",
      "slug": "kak-vernut-zerna",
      "section": { "id": "4b8e2c6d-0a5f-4d9c-b1e7-3f6a2c8d0e14", "title": "Доставка и возврат" },
      "visibility": "all",
      "language": "ru",
      "url": "https://zerno.help.deskus.space/dostavka/kak-vernut-zerna",
      "published_at": "2026-09-14T08:00:00.000Z",
      "updated_at": "2026-10-02T12:31:45.000Z",
      "snippet": "Вернуть нераспечатанную пачку можно в течение 14 дней с момента получения…"
    }
  ]
}

Параметр

Что делает

q

Обязательно. Что искать, до 200 знаков

limit

Сколько статей, до 20; страниц у поиска нет

  • Ищет по-русски с учётом форм слова: «доставка» найдёт и «доставки», и «доставку». Однокоренные слова с другой основой («вернуть» и «возврат») — разные слова.

  • Сначала совпадения в заголовке, потом по весу. Короткое слово — поиск подстрокой, вопрос словами — статьи, где совпало больше слов.

  • Находит только статьи «для всех»: «по ссылке» и «только в виджете» в поиск не попадают — как в справочном центре.

  • snippet — отрывок текста вокруг найденного, без разметки.

Не нашли ответ? Напишите нам
Поддержка ответит в рабочее время.
Вы сотрудник «Дескус»?Изменить статью в Дескусе