Get Folder Parameters disk.folder.get
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: user with "Read" access permission for the required folder
The method disk.folder.get returns data about a folder.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the folder. The identifier can be obtained using the method disk.storage.getChildren if the folder is located at the root of the storage, and using the method disk.folder.getChildren if the folder is located in another folder |
Code Examples
How to Use Examples in Documentation
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_webhook_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
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type DiskFolderGetResult = {
ID: string
NAME: string
CODE: string | null
STORAGE_ID: string
TYPE: string
REAL_OBJECT_ID: string
PARENT_ID: string
DELETED_TYPE: string
CREATE_TIME: ISODate
UPDATE_TIME: ISODate
DELETE_TIME: ISODate | null
CREATED_BY: string
UPDATED_BY: string
DELETED_BY: string
DETAIL_URL: string
}
try {
const response = await $b24.actions.v2.call.make<DiskFolderGetResult>({
method: 'disk.folder.get',
params: {
id: 8930,
},
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('Folder:', result.NAME, '| Storage ID:', result.STORAGE_ID, '| Parent ID:', result.PARENT_ID)
}
} 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 getFolder() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'disk.folder.get',
params: {
id: 8930,
},
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('Folder:', result.NAME, '| Storage ID:', result.STORAGE_ID, '| Parent ID:', result.PARENT_ID)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getFolder)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.disk.folder.get(
bitrix_id=8930,
).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.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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "disk.folder.get", b24.Params{
"id": 8930,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("disk.folder.get: %w", err)
}
var item struct {
ID b24.ID `json:"ID"`
Name string `json:"NAME"`
StorageID b24.ID `json:"STORAGE_ID"`
Type string `json:"TYPE"`
RealObjectID b24.ID `json:"REAL_OBJECT_ID"`
ParentID b24.ID `json:"PARENT_ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Name)
Response Handling
HTTP status: 200
{
"result": {
"ID": "8930",
"NAME": "Folder in folder",
"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.com/company/personal/user/1269/disk/path/Ordner/Ordner in Ordner"
},
"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
}
}
Returned Data
|
Name |
Description |
|
result |
Array with folder data |
|
ID |
Folder identifier |
|
NAME |
Folder name |
|
CODE |
Symbolic code of the folder |
|
STORAGE_ID |
Identifier of the storage where the folder is located |
|
TYPE |
Type of the object |
|
REAL_OBJECT_ID |
Identifier of the object |
|
PARENT_ID |
Identifier of the parent folder |
|
DELETED_TYPE |
Deletion status of the object. Possible values:
|
|
CREATE_TIME |
Date and time of folder creation |
|
UPDATE_TIME |
Date and time of the last update of the folder |
|
DELETE_TIME |
Date and time of moving the folder to the trash |
|
CREATED_BY |
Identifier of the user who created the folder |
|
UPDATED_BY |
Identifier of the user who made the last change |
|
DELETED_BY |
Identifier of the user who deleted the folder |
|
DETAIL_URL |
Link to open the folder in the interface |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":"ERROR_ARGUMENT",
"error_description":"Invalid value of parameter {Parameter #1}"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Invalid value of parameter |
Required parameter |
|
|
Could not find entity with id |
The folder with the specified |
|
|
Access denied |
Insufficient rights to read the folder |
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 Subfolder disk.folder.addSubFolder
- Copy a folder and all its contents to the specified folder disk.folder.copyTo
- Permanently Delete a Folder and All Its Contents disk.folder.deleteTree
- Get a list of files and folders in the folder disk.folder.getChildren
- Get Public Link for Folder disk.folder.getExternalLink
- Get Folder Field Descriptions disk.folder.getFields
- Move Folder to Trash disk.folder.markDeleted
- Move a Folder and All Its Contents to the Specified Folder disk.folder.moveTo
- Rename Folder disk.folder.rename
- Restore Folder from Trash disk.folder.restore
- Assign Access Permissions to Folder disk.folder.shareToUser
- Upload a New File to the Specified Folder disk.folder.uploadFile