Find Documents note.document.search.list
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
noteWho can execute the method: a user with access to the Knowledge base module
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The note.document.search.list method searches for documents by heading and content.
The response contains documents from Knowledge bases to which the user has access, as well as documents with direct access. Archived documents are not included in the results.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
query* |
Search query. Minimum length: Maximum length: |
|
pagination |
Pagination object. Object structure description |
Parameter Pagination
|
Name |
Description |
|
limit |
Page size. Allowed values: from Default: |
The method returns only the first page of results: the hasMore field in the response indicates whether there are additional matches, but there is no cursor for the next page. To retrieve more matches, refine query or increase limit.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{install_address}/rest/api/{user_id}/{webhook_token}/note.document.search.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"query":"borscht recipe","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":"borscht recipe","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: 'borscht recipe',
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: 'borscht recipe',
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='goulash recipe',
pagination=pagination,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'note.document.search.list',
[
'query' => 'borscht recipe',
'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();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'note.document.search.list',
{
query: 'borscht recipe',
pagination: {
limit: 50
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'note.document.search.list',
[
'query' => 'borscht recipe',
'pagination' => [
'limit' => 50
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "note.document.search.list", b24.Params{
"query": "borscht recipe",
"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("parse response: %w", err)
}
fmt.Println(item.HasMore)
Response Handling
HTTP status: 200
{
"result": {
"items": [
{
"documentId": 42,
"collectionId": 123,
"title": "Traditional recipe",
"score": 0.853,
"snippet": "...classic <b>borscht</b> recipe...",
"sharedAccess": false
},
{
"documentId": 43,
"collectionId": null,
"title": "Publicly available recipe",
"score": 0.791,
"snippet": "...quick <b>recipe</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
}
}
Returned Data
|
Name |
Description |
|
result |
Object with search results |
|
items |
List of found documents |
|
items[] |
Found document object |
|
documentId |
Found document identifier |
|
collectionId |
Knowledge base identifier or |
|
title |
Document title |
|
score |
Relative relevance of the match |
|
snippet |
HTML fragment with highlighted matches (tags …) |
|
sharedAccess |
Flag for direct access to the document without access to the entire knowledge base. Possible values:
|
|
hasMore |
|
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": {
"code": "NOTE_SEARCH_QUERY_TOO_SHORT",
"message": "Search query is too short"
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Mandatory field |
Add |
|
|
Field |
Ensure the provided value is of the correct type |
Error Code: NOTE_SEARCH_QUERY_TOO_SHORT
|
Field |
Error description |
How to Fix |
|
|
Search query is too short |
Provide a string at least |
Error Code: NOTE_SEARCH_QUERY_TOO_LONG
|
Field |
Error description |
How to Fix |
|
|
Search query is too long |
Shorten the string to |
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
User does not have access to the Knowledge Base module |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |