Получить список файлов документа note.file.list

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

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

Scope: note

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

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

Метод note.file.list возвращает постранично файлы, прикрепленные к документу, с датой прикрепления.

Файл, загруженный методом note.file.add и не вставленный в текст документа, со временем удаляется фоновой очисткой. Срок отсчитывается от даты createdAt.

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

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

Название
тип

Описание

documentId*
integer

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

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

Список доступен и для документа в архиве или корзине, если пользователь может его открыть

pagination
object

Объект постраничной навигации. Описание структуры объекта.

Для первой страницы не передавайте параметр

Параметр pagination

Название
тип

Описание

limit
integer

Количество файлов на странице.

Допустимые значения: от 1 до 200. Значения больше 200 уменьшаются до 200, нулевое и отрицательное значение заменяется на 50. Нечисловое значение вызывает ошибку валидации.

По умолчанию: 50

afterCursor
object

Курсор следующей страницы. Передавайте значение result.nextCursor из предыдущего ответа без изменений.

Структура курсора служебная и может измениться. Не собирайте курсор вручную

Чтобы получить все файлы документа, вызовите метод без pagination.afterCursor, затем передавайте result.nextCursor из каждого ответа в pagination.afterCursor, пока result.nextCursor не станет null.

Примеры кода

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

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

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/note.file.list

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":131,"pagination":{"limit":1}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.file.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentId":131,"pagination":{"limit":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.file.list

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FileListResult = {
  items: Array<{
    id: number
    documentId: number
    name: string
    size: number
    mimeType: string
    assetType: 'image' | 'video' | 'file'
    assetMarkdown: string
    createdAt: ISODate
  }>
  nextCursor: Record<string, unknown> | null
}

try {
  const response = await $b24.actions.v3.call.make<FileListResult>({
    method: 'note.file.list',
    params: {
      documentId: 131,
      pagination: {
        limit: 1,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Files:', result.items.length, result.nextCursor)
  }
} catch (error) {
  console.error(error)
}

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listFiles() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'note.file.list',
        params: {
          documentId: 131,
          pagination: {
            limit: 1,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Files:', result.items.length, result.nextCursor)
    } catch (error) {
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listFiles)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.note.file.list(
        document_id=131,
        pagination={
            "limit": 1,
        },
    ).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.file.list',
            [
                'documentId' => 131,
                'pagination' => [
                    'limit' => 1,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

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

BX24.callMethod(
    'note.file.list',
    {
        documentId: 131,
        pagination: {
            limit: 1,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

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

require_once('crest.php');

$result = CRest::call(
    'note.file.list',
    [
        'documentId' => 131,
        'pagination' => [
            'limit' => 1,
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.file.list", b24.Params{
	"documentId": 131,
	"pagination": b24.Params{
		"limit": 1,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("note.file.list: %w", err)
}

var result struct {
	Items []struct {
		ID            int    `json:"id"`
		Name          string `json:"name"`
		AssetMarkdown string `json:"assetMarkdown"`
		CreatedAt     string `json:"createdAt"`
	} `json:"items"`
	// Курсор передается в следующий запрос без изменений.
	NextCursor json.RawMessage `json:"nextCursor"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range result.Items {
	fmt.Println(item.ID, item.Name, item.CreatedAt)
}

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

HTTP-статус: 200

{
    "result": {
        "nextCursor": {
            "id": 39387
        },
        "items": [
            {
                "id": 39387,
                "documentId": 131,
                "name": "diagram.png",
                "size": 70,
                "mimeType": "image/png",
                "assetType": "image",
                "assetMarkdown": "[[image fileId=39387]]",
                "createdAt": "2026-10-21T15:38:14+03:00"
            }
        ]
    },
    "time": {
        "start": 1792586295,
        "finish": 1792586295.867693,
        "duration": 0.8676929473876953,
        "processing": 0,
        "date_start": "2026-10-21T15:38:15+03:00",
        "date_finish": "2026-10-21T15:38:15+03:00",
        "operating_reset_at": 1792586880,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект со списком файлов и курсором
result.items `array`	Массив файлов на странице, по возрастанию идентификатора
result.items[].id `integer`	Идентификатор файла
result.items[].documentId `integer`	Идентификатор документа
result.items[].name `string`	Имя файла
result.items[].size `integer`	Размер файла в байтах
result.items[].mimeType `string`	MIME-тип файла
result.items[].assetType `string`	Тип вложения. Возможные значения: `image` — изображение `video` — видео `file` — другой файл
result.items[].assetMarkdown `string`	Блок Markdown для вставки файла в текст документа. Чтобы проверить, вставлен ли файл в текст, найдите этот блок в `markdown` документа из note.document.get
result.items[].createdAt `datetime`	Дата и время прикрепления файла к документу в формате ISO 8601 с часовым поясом. От нее отсчитывается срок фоновой очистки невставленных файлов
result.nextCursor `object` или `null`	Курсор следующей страницы. Передайте его в `pagination.afterCursor` без изменений. `null` — страниц больше нет
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

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

Название `тип`	Описание
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

Поле	Описание ошибки	Как исправить
`documentId`	Обязательное поле `documentId` не указано	Добавьте `documentId` в тело запроса
`documentId`	В поле `documentId` требуется тип данных `int` для такого запроса	Передайте идентификатор числом
`pagination.limit`	must be a number	Передайте число
`afterCursor.id`	must be a number	Передайте курсор из `result.nextCursor` без изменений

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	У пользователя нет доступа к модулю База знаний

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле	Описание ошибки	Как исправить
`documentId`	Запись с ID = `#ID#` не найдена	Документ не существует или недоступен пользователю

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

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

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

Была ли статья полезна?

Получить данные файла документа

Получить поле файла документа

Получить список файлов документа note.file.list

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

Параметр paginationПараметр pagination

Примеры кодаПримеры кода

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

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

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

Возможные коды ошибокВозможные коды ошибок

Ошибки валидации запросаОшибки валидации запроса

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

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

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

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

Была ли статья полезна?

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

Параметр pagination

Примеры кода

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

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

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

Возможные коды ошибок

Ошибки валидации запроса

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

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

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

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