Найти документы note.document.search.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: note

Кто может выполнять метод: пользователь с доступом к модулю База знаний

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.document.search.list ищет документы по заголовку и содержимому.

Выдача содержит документы из баз знаний, к которым у пользователя есть доступ, а также документы с прямым доступом к документу. Архивные документы не попадают в результат.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

query*
string

Поисковый запрос.

Минимальная длина: 3 символа

Максимальная длина: 200 символов

pagination
object

Объект постраничной навигации. Описание структуры объекта

Параметр pagination

Название
тип

Описание

limit
integer

Размер страницы.

Допустимые значения: от 1 до 200

По умолчанию: 50

Метод возвращает только первую страницу результатов: поле hasMore в ответе показывает, есть ли дополнительные совпадения, но курсора на следующую страницу нет. Чтобы получить больше совпадений, уточняйте query или увеличивайте limit.

Примеры кода

Как использовать примеры в документации

Вызов нового api отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/note.document.search.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"query":"рецепт борща","pagination":{"limit":50}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.search.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"query":"рецепт борща","pagination":{"limit":50},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.document.search.list

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type DocumentSearchListResult = {
  items: Array<{
    documentId: number
    collectionId: number | null
    title: string
    score: number
    snippet: string
    sharedAccess: boolean
  }>
  hasMore: boolean
}

try {
  const response = await $b24.actions.v3.call.make<DocumentSearchListResult>({
    method: 'note.document.search.list',
    params: {
      query: 'рецепт борща',
      pagination: {
        limit: 50,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Found documents:', result.items.length, result.hasMore)
  }
} catch (error) {
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function searchDocuments() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'note.document.search.list',
        params: {
          query: 'рецепт борща',
          pagination: {
            limit: 50,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Found documents:', result.items.length, result.hasMore)
    } catch (error) {
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', searchDocuments)
</script>

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'note.document.search.list',
            [
                'query' => 'рецепт борща',
                'pagination' => [
                    'limit' => 50,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error searching documents: ' . $e->getMessage();
}

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

BX24.callMethod(
    'note.document.search.list',
    {
        query: 'рецепт борща',
        pagination: {
            limit: 50
        }
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

require_once('crest.php');

$result = CRest::call(
    'note.document.search.list',
    [
        'query' => 'рецепт борща',
        'pagination' => [
            'limit' => 50
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.document.search.list", b24.Params{
	"query": "рецепт борща",
	"pagination": b24.Params{
		"limit": 50,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("note.document.search.list: %w", err)
}

var item struct {
	HasMore bool `json:"hasMore"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.HasMore)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "documentId": 42,
                "collectionId": 123,
                "title": "Традиционный рецепт",
                "score": 0.853,
                "snippet": "...классический <b>рецепт</b> украинского <b>борща</b>...",
                "sharedAccess": false
            },
            {
                "documentId": 43,
                "collectionId": null,
                "title": "Рецепт из общего доступа",
                "score": 0.791,
                "snippet": "...быстрый <b>рецепт</b>...",
                "sharedAccess": true
            }
        ],
        "hasMore": true
    },
    "time": {
        "start": 1780640100,
        "finish": 1780640100.286773,
        "duration": 0.2867729663848877,
        "processing": 0.24144291877746582,
        "date_start": "2026-06-19T10:15:00+03:00",
        "date_finish": "2026-06-19T10:15:00+03:00",
        "operating_reset_at": 1780640700,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с результатами поиска

items
array

Список найденных документов

items[]
object

Объект найденного документа

documentId
integer

Идентификатор найденного документа

collectionId
integer

Идентификатор базы знаний или null, если документ доступен через прямой доступ к документу

title
string

Заголовок документа

score
double

Относительная релевантность совпадения

snippet
string

HTML-фрагмент с выделением совпадений (теги …)

sharedAccess
boolean

Признак прямого доступа к документу без доступа ко всей базе знаний.

Возможные значения:

  • true — документ доступен через прямой доступ
  • false — документ доступен через доступ к базе знаний

hasMore
boolean

Значение true, если за пределами страницы есть еще результаты

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "NOTE_SEARCH_QUERY_TOO_SHORT",
        "message": "Поисковый запрос слишком короткий"
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

query

Обязательное поле query не указано

Добавьте query в тело запроса

query
pagination

В поле #FIELD# требуется тип данных #TYPE# для такого запроса

Убедитесь, что передаваемое значение нужного типа

Код ошибки: NOTE_SEARCH_QUERY_TOO_SHORT

Поле

Описание ошибки

Как исправить

query

Поисковый запрос слишком короткий

Передайте строку длиной не менее 3 символов

Код ошибки: NOTE_SEARCH_QUERY_TOO_LONG

Поле

Описание ошибки

Как исправить

query

Поисковый запрос слишком длинный

Сократите строку до 200 символов

Ошибки доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

У пользователя нет доступа к модулю База знаний

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить дерево документов
Следующая
Получить поле документа