Получить параметры папки disk.folder.get

Scope: disk

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

Метод disk.folder.get возвращает данные о папке.

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

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

Название
тип

Описание

id*
integer

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

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8930}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/disk.folder.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":8930,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.folder.get
        
try
        {
            const response = await $b24.callMethod(
                'disk.folder.get',
                {
                    id: 8930,
                }
            );
            
            const result = response.getData().result;
            console.log('Retrieved folder with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.folder.get',
                    [
                        'id' => 8930
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving folder: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.folder.get",
            {
                id: 8930
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'disk.folder.get',
            [
                'id' => 8930
            ]
        );
        
        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/Папка/Папка в папке"
            },
            "time": {
                "start": 1768904310,
                "finish": 1768904310.320223,
                "duration": 0.3202230930328369,
                "processing": 0,
                "date_start": "2026-01-19T13:18:30+03:00",
                "date_finish": "2026-01-29T13:18:30+03:00",
                "operating_reset_at": 1768904910,
                "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 — удален вместе с родительской папкой

CREATE_TIME
datetime

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

UPDATE_TIME
datetime

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

DELETE_TIME
datetime

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

CREATED_BY
integer

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

UPDATED_BY
integer

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

DELETED_BY
integer

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

DETAIL_URL
string

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

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 не найдена

ACCESS_DENIED

Access denied

Недостаточно прав для чтения папки

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

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

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

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

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