Get a list of files and folders in the root of the storage disk.storage.getchildren

Scope: disk

Who can execute the method: any user

The method disk.storage.getchildren returns a list of files and folders located in the root of the storage.

Only those files and folders for which the user has "Read" access permission are returned.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the storage.

The identifier can be obtained using the method disk.storage.getlist

filter
array

Array format:

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

where:

  • field_n — the name of the field to filter by
  • value_n — the filter value

You can add a prefix to the keys field_n to specify the filter operation.
Possible prefix values:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring in any position of the string
  • =% — LIKE, substring search. The % symbol must be passed in the value. Examples:
    • "mol%" — searches for values starting with "mol"
    • "%mol" — searches for values ending with "mol"
    • "%mol%" — searches for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • = — equal, exact match (used by default)
  • != — not equal
  • ! — not equal

The list of fields available for filtering can be obtained using the method disk.folder.getfields

order
array

Array format:

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

where:

  • field_n — the name of the field to sort by
  • value_n — a string value equal to:
    • ASC — ascending sort
    • DESC — descending sort

The list of fields available for sorting can be obtained using the method disk.folder.getfields

start
integer

This parameter is used to manage pagination.

The page size of results is always static — 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N - 1) * 50, where N — the number of the desired page

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1357,"filter":{"NAME":"%Folder%"},"order":{"NAME":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.storage.getchildren
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":1357,"filter":{"NAME":"%Folder%"},"order":{"NAME":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.storage.getchildren
        
try
        {
            const response = await $b24.callMethod(
                'disk.storage.getchildren',
                {
                    id: 1357,
                    filter: {
                        NAME: '%Folder%',
                    },
                    order: {
                        NAME: 'DESC',
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Retrieved children:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.storage.getchildren',
                    [
                        'id' => 1357,
                        'filter' => [
                            'NAME' => '%Folder%'
                        ],
                        'order' => [
                            'NAME' => 'DESC'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving children: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.storage.getchildren",
            {
                id: 1357,
                filter: {
                    NAME: '%Folder%'
                },
                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.storage.getchildren',
            [
                'id' => 1357,
                'filter' => [
                    'NAME' => '%Folder%'
                ],
                'order' => [
                    'NAME' => 'DESC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "ID": "8960",
                    "NAME": "Folder in folder",
                    "CODE": null,
                    "STORAGE_ID": "1357",
                    "TYPE": "folder",
                    "REAL_OBJECT_ID": "8960",
                    "PARENT_ID": "8875",
                    "DELETED_TYPE": "0",
                    "CREATE_TIME": "2026-01-14T15:01:14+02:00",
                    "UPDATE_TIME": "2026-01-14T15:01:14+02:00",
                    "DELETE_TIME": null,
                    "CREATED_BY": "1269",
                    "UPDATED_BY": "1269",
                    "DELETED_BY": "0",
                    "DETAIL_URL": "https://test.bitrix24.com/company/personal/user/1269/disk/path/Folder in folder"
                },
                {
                    "ID": "8907",
                    "NAME": "Folder",
                    "CODE": null,
                    "STORAGE_ID": "1357",
                    "TYPE": "folder",
                    "REAL_OBJECT_ID": "8907",
                    "PARENT_ID": "8875",
                    "DELETED_TYPE": "0",
                    "CREATE_TIME": "2025-12-30T14:16:49+02:00",
                    "UPDATE_TIME": "2026-01-21T13:53:51+02:00",
                    "DELETE_TIME": null,
                    "CREATED_BY": "1269",
                    "UPDATED_BY": "1269",
                    "DELETED_BY": "0",
                    "DETAIL_URL": "https://test.bitrix24.com/company/personal/user/1269/disk/path/Folder"
                },
                {
                    "ID": "9023",
                    "NAME": "New folder",
                    "CODE": null,
                    "STORAGE_ID": "1357",
                    "TYPE": "folder",
                    "REAL_OBJECT_ID": "9023",
                    "PARENT_ID": "8875",
                    "DELETED_TYPE": "0",
                    "CREATE_TIME": "2026-01-26T13:30:15+02:00",
                    "UPDATE_TIME": "2026-01-26T13:30:15+02:00",
                    "DELETE_TIME": null,
                    "CREATED_BY": "1269",
                    "UPDATED_BY": "1269",
                    "DELETED_BY": null,
                    "DETAIL_URL": "https://test.bitrix24.com/company/personal/user/1269/disk/path/New folder"
                }
            ],
            "total": 3,
            "time": {
                "start": 1769539624,
                "finish": 1769539624.498846,
                "duration": 0.49884605407714844,
                "processing": 0,
                "date_start": "2026-01-26T14:47:04+02:00",
                "date_finish": "2026-01-26T14:47:04+02:00",
                "operating_reset_at": 1769540224,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
array

List of files and folders with field descriptions.

An empty array means that the user does not have permission to view the files and folders located in the root of the storage

ID
integer

Identifier of the file/folder

NAME
string

Name of the file/folder

CODE
string

Symbolic code of the file/folder

STORAGE_ID
integer

Identifier of the storage where the file/folder is located

TYPE
enum

Type of the object

REAL_OBJECT_ID
integer

Identifier of the object

PARENT_ID
integer

Identifier of the parent folder

DELETED_TYPE
enum

Deletion status of the object. Possible values:

  • 0 — not deleted
  • 3 — in the trash
  • 4 — deleted along with the parent folder

GLOBAL_CONTENT_VERSION
integer

Incremental version counter of the file

FILE_ID
integer

Internal value of the file identifier

SIZE
integer

Size of the file in bytes

CREATE_TIME
datetime

Date and time of file/folder creation

UPDATE_TIME
datetime

Date and time of the last update of the file/folder

DELETE_TIME
datetime

Date and time the file/folder was moved to the trash

CREATED_BY
integer

Identifier of the user who created the file/folder

UPDATED_BY
integer

Identifier of the user who made the last change

DELETED_BY
integer

Identifier of the user who deleted the file/folder

DOWNLOAD_URL
string

Link to download the file

DETAIL_URL
string

Link to open the file/folder in the interface

total
integer

Total number of files and folders

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

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

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

Value

ERROR_ARGUMENT

Invalid value of parameter

The required parameter id is not specified

ERROR_NOT_FOUND

Could not find entity with id X

The storage with the specified id was not found

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Create a Folder in the Root of the Storage
Next
Get Storage Fields