Get a List of Available Storages disk.storage.getlist

Scope: disk

Who can execute the method: any user

The method disk.storage.getlist returns a list of available storages.

Method Parameters

Required parameters are marked with *

Name `type`	Description
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 should not be included in the filter value. The search looks for the substring in any position of the string `=%` — LIKE, substring search. The `%` symbol should be included 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.storage.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.storage.getfields
start `integer`	This parameter is used to manage pagination. The page size for 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 desired page number

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"NAME":"%Bitrix24%"},"order":{"NAME":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.storage.getlist

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"NAME":"%Bitrix24%"},"order":{"NAME":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.storage.getlist

// callListMethod: Retrieves all data at once.
        // Use only for small selections (< 1000 items) due to high
        // memory load.
        
        try {
        const response = await $b24.callListMethod(
            'disk.storage.getlist',
            {
            filter: {
                NAME: '%Bitrix24%',
            },
            order: {
                NAME: 'DESC'
            }
            },
            (progress) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator.
        // Use for large volumes of data for efficient memory consumption.
        
        try {
        const generator = $b24.fetchListMethod('disk.storage.getlist', {
            filter: {
            NAME: '%Bitrix24%',
            },
            order: {
            NAME: 'DESC'
            }
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // callMethod: Manual control of pagination through the start parameter.
        // Use for precise control over request batches.
        // Less efficient for large data than fetchListMethod.
        
        try {
        const response = await $b24.callMethod('disk.storage.getlist', {
            filter: {
            NAME: '%Bitrix24%',
            },
            order: {
            NAME: 'DESC'
            }
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.storage.getlist',
                    [
                        'filter' => [
                            'NAME' => '%Bitrix24%',
                        ],
                        'order' => [
                            'NAME' => 'DESC'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching storage list: ' . $e->getMessage();
        }

BX24.callMethod(
            "disk.storage.getlist",
            {
                filter: {
                    NAME: '%Bitrix24%',
                },
                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.getlist',
            [
                'filter' => [
                    'NAME' => '%Bitrix24%',
                ],
                'order' => [
                    'NAME' => 'DESC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": [
                {
                "ID": "13",
                "NAME": "Support Bitrix24",
                "CODE": null,
                "MODULE_ID": "disk",
                "ENTITY_TYPE": "user",
                "ENTITY_ID": "3",
                "ROOT_OBJECT_ID": "21"
                },
                {
                "ID": "1335",
                "NAME": "Bitrix24 Integration Module",
                "CODE": null,
                "MODULE_ID": "disk",
                "ENTITY_TYPE": "user",
                "ENTITY_ID": "1255",
                "ROOT_OBJECT_ID": "8755"
                }
            ],
            "total": 2,
            "time": {
                "start": 1770044358,
                "finish": 1770044358.241043,
                "duration": 0.2410430908203125,
                "processing": 0,
                "date_start": "2026-02-02T11:29:18+01:00",
                "date_finish": "2026-02-02T11:29:18+01:00",
                "operating_reset_at": 1770044958,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	An array of available storages. An empty array means that the user does not have access to storages or there are no records that meet the filter criteria
ID `integer`	Storage identifier
NAME `string`	Storage name
CODE `string`	Symbolic code of the storage
MODULE_ID `string`	Identifier of the module to which the storage belongs
ENTITY_TYPE `string`	Type of the object associated with the storage. Possible values: `user` — user storage `common` — common documents storage `group` — group storage
ENTITY_ID `string`	Identifier of the object associated with the storage
ROOT_OBJECT_ID `integer`	Identifier of the root folder of the storage
total `integer`	Total number of records found
time `time`	Information about the request execution time

Error Handling

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

Get the Description of the Application Storage

Get Storage Types

Get a List of Available Storages disk.storage.getlist

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning