Get a List of Available Storages disk.storage.getList
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
diskWho 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 |
Description |
|
filter |
Array format:
where:
You can add a prefix to the keys
The list of fields available for filtering can be obtained using the method disk.storage.getFields |
|
order |
Array format:
where:
The list of fields available for sorting can be obtained using the method disk.storage.getFields |
|
start |
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 The formula for calculating the
|
Code Examples
How to Use Examples in Documentation
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each StorageItem returned in result[]
type StorageItem = {
ID: string
NAME: string
CODE: string | null
MODULE_ID: string
ENTITY_TYPE: string
ENTITY_ID: string
ROOT_OBJECT_ID: string
}
try {
// disk.storage.getList returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<StorageItem[]>({
method: 'disk.storage.getList',
params: {
filter: {
NAME: '%Bitrix24%',
},
order: {
NAME: 'DESC',
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Storages:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getStorageList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// disk.storage.getList returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'disk.storage.getList',
params: {
filter: {
NAME: '%Bitrix24%',
},
order: {
NAME: 'DESC',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Storages:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getStorageList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.disk.storage.getlist(
filter={
"NAME": "%Bitrix24%",
},
order={
"NAME": "DESC",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "disk.storage.getList", b24.Params{
"filter": b24.Params{
"NAME": "%Bitrix24%",
},
"order": b24.Params{
"NAME": "DESC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("disk.storage.getList: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
ModuleID string `json:"MODULE_ID"`
EntityType string `json:"ENTITY_TYPE"`
EntityID b24.ID `json:"ENTITY_ID"`
RootObjectID b24.ID `json:"ROOT_OBJECT_ID"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
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 |
Description |
|
result |
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 |
Storage identifier |
|
NAME |
Storage name |
|
CODE |
Symbolic code of the storage |
|
MODULE_ID |
Identifier of the module to which the storage belongs |
|
ENTITY_TYPE |
Type of the object associated with the storage. Possible values:
|
|
ENTITY_ID |
Identifier of the object associated with the storage |
|
ROOT_OBJECT_ID |
Identifier of the root folder of the storage |
|
total |
Total number of records found |
|
time |
Information about the request execution time |
Error Handling
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a Folder in the Root of the Storage disk.storage.addFolder
- Get a list of files and folders in the root of the storage disk.storage.getChildren
- Get Description of Storage Fields disk.storage.getFields
- Get Application Storage Description disk.storage.getForApp
- Get Storage Types disk.storage.getTypes
- Get Storage Description disk.storage.get
- Rename Application Storage disk.storage.rename
- Upload a New File to the Root of the Storage disk.storage.uploadFile