Получить список файлов и папок, находящихся в папке disk.folder.getchildren

Scope: disk

Кто может выполнять метод: любой пользователь

Метод disk.folder.getchildren возвращает список файлов и папок, которые находятся в папке.

Возвращаются только те файлы и папки, к которым у пользователя есть право «Чтение»

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

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

Название
тип

Описание

id*
integer

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

Идентификатор можно получить с помощью метода disk.storage.getchildren, если папка находится в корне хранилища, и с помощью метода disk.folder.getchildren, если папка находится в другой папке

filter
array

Массив формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

где:

  • field_n — название поля, по которому будет произведена фильтрация
  • value_n — значение фильтра

К ключам field_n можно добавить префикс, уточняющий работу фильтра.
Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

Список доступных для фильтрации полей можно узнать с помощью метода disk.folder.getfields

order
array

Массив формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

где:

  • field_n — название поля, по которому будет произведена сортировка
  • value_n — значение типа string, равное:
    • ASC — сортировка по возрастанию
    • DESC — сортировка по убыванию

Список доступных для сортировки полей можно узнать с помощью метода disk.folder.getfields

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N - 1) * 50, где N — номер нужной страницы

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8907,"filter":{">=CREATE_TIME":"2026-01-12"},"order":{"NAME":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.folder.getchildren
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8907,"filter":{">=CREATE_TIME":"2026-01-12"},"order":{"NAME":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.folder.getchildren
        
try
        {
            const response = await $b24.callMethod(
                'disk.folder.getchildren',
                {
                    id: 8907,
                    filter: {
                        '>=CREATE_TIME': '2026-01-12'
                    },
                    order: {
                        NAME: 'DESC'
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Data:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.folder.getchildren',
                    [
                        'id' => 8907,
                        'filter' => [
                            '>=CREATE_TIME' => '2026-01-12'
                        ],
                        'order' => [
                            'NAME' => 'DESC'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.folder.getchildren",
            {
                id: 8907,
                filter: {
                    '>=CREATE_TIME': '2026-01-12'
                },
                order: {
                    NAME: 'DESC'
                }
            },
            function (result) {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'disk.folder.getchildren',
            [
                'id' => 8907,
                'filter' => [
                    '>=CREATE_TIME' => '2026-01-12'
                ],
                'order' => [
                    'NAME' => 'DESC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "8930",
                    "NAME": "Папка в папке",
                    "CODE": null,
                    "STORAGE_ID": "1357",
                    "TYPE": "folder",
                    "REAL_OBJECT_ID": "8930",
                    "PARENT_ID": "8907",
                    "DELETED_TYPE": "0",
                    "CREATE_TIME": "2026-01-13T16:16:35+03:00",
                    "UPDATE_TIME": "2026-01-13T16:16:35+03:00",
                    "DELETE_TIME": null,
                    "CREATED_BY": "1269",
                    "UPDATED_BY": "1269",
                    "DELETED_BY": "0",
                    "DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1269/disk/path/Папка/Папка в папке"
                },
                {
                    "ID": "8964",
                    "NAME": "Картинка.png",
                    "CODE": null,
                    "STORAGE_ID": "1357",
                    "TYPE": "file",
                    "PARENT_ID": "8907",
                    "DELETED_TYPE": "0",
                    "GLOBAL_CONTENT_VERSION": "1",
                    "FILE_ID": "32718",
                    "SIZE": "52486",
                    "CREATE_TIME": "2026-01-14T17:05:05+03:00",
                    "UPDATE_TIME": "2026-01-14T17:05:39+03:00",
                    "DELETE_TIME": null,
                    "CREATED_BY": "1269",
                    "UPDATED_BY": "1269",
                    "DELETED_BY": "0",
                    "DOWNLOAD_URL": "https://test.bitrix24.ru/rest/download.json?auth=d9c467690000071b006e2cf2000004f5000007248f2adc44d050ace99adb3cb9d0f1aa&token=disk%7CaWQ9ODk2NCZfPU9zTE4wUFNMRVBacFJiZXF6Q203dkY4d3V6ZUQyd0Rt%7CImRvd25sb2FkfGRpc2t8YVdROU9EazJOQ1pmUFU5elRFNHdVRk5NUlZCYWNGSmlaWEY2UTIwM2RrWTRkM1Y2WlVReWQwUnR8ZDljNDY3NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDcyNDhmMmFkYzQ0ZDA1MGFjZTk5YWRiM2NiOWQwZjFhYSI%3D.oSqXbtR%2FjZL8%2BfY%2BUvgqYQdxoHVh7PCvocXUvtS9n4s%3D",
                    "DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1269/disk/file/Папка/Картинка.png"
                },
                {
                    "ID": "8936",
                    "NAME": "Документы",
                    "CODE": null,
                    "STORAGE_ID": "1357",
                    "TYPE": "folder",
                    "REAL_OBJECT_ID": "8936",
                    "PARENT_ID": "8907",
                    "DELETED_TYPE": "0",
                    "CREATE_TIME": "2026-01-13T17:00:40+03:00",
                    "UPDATE_TIME": "2026-01-14T17:05:25+03:00",
                    "DELETE_TIME": null,
                    "CREATED_BY": "1271",
                    "UPDATED_BY": "1271",
                    "DELETED_BY": "0",
                    "DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1269/disk/path/Папка/Документы"
                }
            ],
            "total": 3,
            "time": {
                "start": 1768407161,
                "finish": 1768407161.323201,
                "duration": 0.32320094108581543,
                "processing": 0,
                "date_start": "2026-01-14T17:12:41+03:00",
                "date_finish": "2026-01-14T17:12:41+03:00",
                "operating_reset_at": 1768407761,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
array

Список файлов и папок с описанием полей.

Пустой массив означает, что у пользователя нет прав на просмотр файлов и папок, находящихся в указанной папке

ID
integer

Идентификатор файла/папки

NAME
string

Имя файла/папки

CODE
string

Символьный код файла/папки

STORAGE_ID
integer

Идентификатор хранилища, в котором находится файл/папка

TYPE
enum

Тип объекта

REAL_OBJECT_ID
integer

Идентификатор объекта

PARENT_ID
integer

Идентификатор родительской папки

DELETED_TYPE
enum

Статус удаления объекта. Возможные значения:

  • 0 — не удален
  • 3 — в корзине
  • 4 — удален вместе с родительской папкой

GLOBAL_CONTENT_VERSION
integer

Инкрементальный счетчик версии файла

FILE_ID
integer

Внутреннее значение идентификатора файла

SIZE
integer

Размер файла в байтах

CREATE_TIME
datetime

Дата и время создания файла/папки

UPDATE_TIME
datetime

Дата и время последнего обновления файла/папки

DELETE_TIME
datetime

Дата и время переноса файла/папки в корзину

CREATED_BY
integer

Идентификатор пользователя, создавшего файл/папку

UPDATED_BY
integer

Идентификатор пользователя, внесшего последнее изменение

DELETED_BY
integer

Идентификатор пользователя, удалившего файл/папку

DOWNLOAD_URL
string

Ссылка для скачивания файла

DETAIL_URL
string

Ссылка для открытия файла/папки в интерфейсе

total
integer

Общее количество файлов и папок

time
time

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

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

HTTP-статус: 400

{
            "error":"ERROR_ARGUMENT",
            "error_description":"Invalid value of parameter {Parameter #1}"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

ERROR_ARGUMENT

Invalid value of parameter

Не указан обязательный параметр id

ERROR_NOT_FOUND

Could not find entity with id X

Папка с указанным id не найдена

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Удалить папку и все ее содержимое
Следующая
Получить публичную ссылку на папку