note.document.search.list
Найти документы
Описание
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод note.document.search.list ищет документы по заголовку и содержимому.
Выдача содержит документы из баз знаний, к которым у пользователя есть доступ, а также документы с прямым доступом к документу. Архивные документы не попадают в результат.
Параметры
query
string
обязательный
Поисковый запрос.
Минимальная длина: 3 символа
Максимальная длина: 200 символов
pagination
object
необязательный
Объект постраничной навигации. Описание структуры объекта
Параметр pagination
limit
integer
необязательный
Размер страницы.
Допустимые значения: от 1 до 200
По умолчанию: 50
Примеры запроса
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
pagination = {
"limit": 50,
}
try:
bitrix_response = client.note.document.search.list(
query='рецепт борща',
pagination=pagination,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
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();
}
BX24.callMethod(
'note.document.search.list',
{
query: 'рецепт борща',
pagination: {
limit: 50
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
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-фрагмент с выделением совпадений (теги <b>…</b>)
sharedAccess
boolean
Признак прямого доступа к документу без доступа ко всей базе знаний.
Возможные значения:
true— документ доступен через прямой доступfalse— документ доступен через доступ к базе знаний
hasMore
boolean
Значение true, если за пределами страницы есть еще результаты
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "NOTE_SEARCH_QUERY_TOO_SHORT",
"message": "Поисковый запрос слишком короткий"
}
}
| Код | Описание | Значение |
|---|---|---|
Поле |
Описание ошибки | Как исправить |
query |
Обязательное поле query не указано |
Добавьте query в тело запроса |
query pagination |
В поле #FIELD# требуется тип данных #TYPE# для такого запроса |
Убедитесь, что передаваемое значение нужного типа |

