Find Documents note.document.search.list

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: note

Who can execute the method: a user with access to the Knowledge base module

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
type

Description

query*
string

Search query.

Minimum length: 3 characters

Maximum length: 200 characters

pagination
object

Pagination object. Object structure description

Parameter Pagination

Name
type

Description

limit
integer

Page size.

Allowed values: from 1 to 200

Default: 50

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 (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

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>

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>';

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 `type`	Description
result `object`	Object with search results
items `array`	List of found documents
items[] `object`	Found document object
documentId `integer`	Found document identifier
collectionId `integer`	Knowledge base identifier or `null` if the document is available via direct access to the document
title `string`	Document title
score `double`	Relative relevance of the match
snippet `string`	HTML fragment with highlighted matches (tags …)
sharedAccess `boolean`	Flag for direct access to the document without access to the entire knowledge base. Possible values: `true` — document is available via direct access `false` — document is available via knowledge base access
hasMore `boolean`	`true` value if there are more results beyond the current page
time `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 `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	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
`query`	Mandatory field `query` is not specified	Add `query` to the request body
`query` `pagination`	Field `#FIELD#` requires data type `#TYPE#` for such a request	Ensure the provided value is of the correct type

Error Code: NOTE_SEARCH_QUERY_TOO_SHORT

Field	Error description	How to Fix
`query`	Search query is too short	Provide a string at least `3` characters long

Error Code: NOTE_SEARCH_QUERY_TOO_LONG

Field	Error description	How to Fix
`query`	Search query is too long	Shorten the string to `200` characters

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: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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

Continue Learning

Get Document Tree

Get Document Field

Find Documents note.document.search.list

Method ParametersMethod Parameters

Parameter PaginationParameter Pagination

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Access ErrorsAccess Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter Pagination

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Access Errors

Statuses and System Error Codes

Continue Learning