Get Document Tree note.document.tree.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 and "View" permissions for the document knowledge base
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.tree.list method returns the document tree of a single knowledge base.
Archived documents are not included in the response.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
collectionId* |
Knowledge base identifier. The identifier can be obtained using the note.collection.list method. |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/note.document.tree.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"collectionId":123}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.tree.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"collectionId":123,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.document.tree.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type TreeNode = {
id: number
collectionId: number
parentId: number | null
title: string
position: number
children: TreeNode[]
}
type DocumentTreeListResult = {
items: TreeNode[]
truncated: boolean
}
try {
const response = await $b24.actions.v3.call.make<DocumentTreeListResult>({
method: 'note.document.tree.list',
params: {
collectionId: 123,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Tree roots:', result.items.length, result.truncated)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getDocumentTree() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.document.tree.list',
params: {
collectionId: 123,
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Tree roots:', result.items.length, result.truncated)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDocumentTree)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.note.document.tree.list(
collection_id=123,
).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.tree.list',
[
'collectionId' => 123,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting document tree: ' . $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.tree.list',
{
collectionId: 123
},
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.tree.list',
[
'collectionId' => 123
]
);
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.tree.list", b24.Params{
"collectionId": 123,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("note.document.tree.list: %w", err)
}
var item struct {
Truncated bool `json:"truncated"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Truncated)
Response Handling
HTTP status: 200
{
"result": {
"items": [
{
"id": 10,
"collectionId": 123,
"parentId": null,
"title": "Introduction",
"position": 1,
"children": [
{
"id": 11,
"collectionId": 123,
"parentId": 10,
"title": "Chapter 1",
"position": 1,
"children": []
}
]
}
],
"truncated": false
},
"time": {
"start": 1780639500,
"finish": 1780639500.268512,
"duration": 0.2685120105743408,
"processing": 0.22631406784057617,
"date_start": "2026-06-19T10:05:00+03:00",
"date_finish": "2026-06-19T10:05:00+03:00",
"operating_reset_at": 1780640100,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the document tree |
|
items |
Root nodes of the document tree |
|
items[] |
Tree document object |
|
id |
Document identifier |
|
collectionId |
Knowledge base identifier |
|
parentId |
Identifier of the parent document or |
|
title |
Document title |
|
position |
Position of the document among neighboring pages |
|
children |
Child pages of the document |
|
truncated |
The value of Exception — the first root document. If it alone exceeds the internal limit |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error during request object validation",
"validation": [
{
"message": "Mandatory field `collectionId` is missing",
"field": "collectionId"
}
]
}
}
|
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 |
|
|
Required field |
Add |
|
|
Field |
Ensure the provided value is of the correct type |
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
The user does not have access to the Knowledge Base module or the permissions to view the specified knowledge base |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Knowledge base not found |
Please check that the knowledge base exists and is accessible to the user |
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 |