{% note tip "" %}
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
{% endnote %}
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.
{% include Note on required parameters %}
#|
|| Name
type | Description ||
|| id*
integer | 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 || |#
{% include Note on examples %}
{% list tabs %}
-
cURL (Webhook)
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 (OAuth)
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
-
JS (TS)
// 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) }
-
JS (UMD)
<!-- 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>
-
PHP
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.js
BX24.callMethod( "disk.folder.get", { id: 8930 }, function (result) { if (result.error()) console.error(result.error()); else console.dir(result.data()); } );
-
PHP CRest
require_once('crest.php'); $result = CRest::call( 'disk.folder.get', [ 'id' => 8930 ] ); echo '<PRE>'; print_r($result); echo '</PRE>';
-
Go
// 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)
{% endlist %}
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
}
}#|
|| Name
type | Description ||
|| result
array | Array with folder data ||
|| ID
integer | Folder identifier ||
|| NAME
string | Folder name ||
|| CODE
string | Symbolic code of the folder ||
|| STORAGE_ID
integer | Identifier of the storage where the 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 deleted3— in the trash4— deleted along with the parent folder || || CREATE_TIMEdatetime| Date and time of folder creation || || UPDATE_TIMEdatetime| Date and time of the last update of the folder || || DELETE_TIMEdatetime| Date and time of moving the folder to the trash || || CREATED_BYinteger| Identifier of the user who created the folder || || UPDATED_BYinteger| Identifier of the user who made the last change || || DELETED_BYinteger| Identifier of the user who deleted the folder || || DETAIL_URLstring| Link to open the folder in the interface || || timetime| Information about the request execution time || |#
HTTP status: 400
{
"error":"ERROR_ARGUMENT",
"error_description":"Invalid value of parameter {Parameter #1}"
}{% include notitle Error handling %}
#|
|| Code | Description | Value ||
|| ERROR_ARGUMENT | Invalid value of parameter {Parameter #1} | Required parameter id is not specified ||
|| ERROR_NOT_FOUND | Could not find entity with id X | The folder with the specified id was not found ||
|| ACCESS_DENIED | Access denied | Insufficient rights to read the folder ||
|#
{% include System errors %}