Получить дерево документов note.document.tree.list

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

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

Scope: note

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

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

Метод note.document.tree.list возвращает дерево документов одной базы знаний.

Архивные документы не попадают в ответ.

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

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

Название
тип

Описание

collectionId*
integer

Идентификатор базы знаний.

Идентификатор можно получить методом note.collection.list

Примеры кода

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

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

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/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",
        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}")

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, 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();
}

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

BX24.callMethod(
    'note.document.tree.list',
    {
        collectionId: 123
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);

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

require_once('crest.php');

$result = CRest::call(
    'note.document.tree.list',
    [
        'collectionId' => 123
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
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("разбор ответа: %w", err)
}
fmt.Println(item.Truncated)

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

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 10,
                "collectionId": 123,
                "parentId": null,
                "title": "Введение",
                "position": 1,
                "children": [
                    {
                        "id": 11,
                        "collectionId": 123,
                        "parentId": 10,
                        "title": "Глава 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
    }
}

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

Название
тип

Описание

result
object

Объект с деревом документов

items
array

Корневые узлы дерева документов

items[]
object

Объект документа дерева

id
integer

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

collectionId
integer

Идентификатор базы знаний

parentId
integer

Идентификатор родительского документа или null для корневой страницы

title
string

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

position
integer

Позиция документа среди соседних страниц

children
array

Дочерние страницы документа

truncated
boolean

Значение true, если дерево превышало внутренний лимит TREE_MAX_NODES = 5000 и было обрезано по корневым узлам.

Исключение — первый корневой документ. Если он один превышает внутренний лимит TREE_MAX_NODES, метод вернет его начальную часть в порядке обхода в ширину, чтобы ответ не оказался пустым

time
time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Обязательное поле `collectionId` не указано",
                "field": "collectionId"
            }
        ]
    }
}

Название
тип

Описание

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

Поле

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

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

collectionId

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

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

collectionId

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

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

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

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

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

-

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

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

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле

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

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

collectionId

База знаний не найдена

Проверьте, что база знаний существует и доступна пользователю

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Архивировать документ
Следующая
Найти документы