For AI agents: markdown of this page — /docs-content-en/entities/storages/get.md documentation index — /llms.txt

Get a storage

GET /v1/storages/:id

Returns a single Bitrix24 Drive storage by identifier.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionStorage identifier

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/storages/1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/storages/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/storages/1', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Storage:', data.name, '—', data.entityType)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/storages/1', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.id Typenumber DescriptionStorage identifier
Fielddata.name Typestring DescriptionStorage name
Fielddata.code Typestring | null DescriptionSymbolic code. null on the Bitrix24 accounts checked
Fielddata.module Typestring DescriptionOwner module of the storage, disk for Drive
Fielddata.entityType Typestring DescriptionOwner type: user, group, common
Fielddata.entityId Typestring DescriptionOwner identifier. A string, non-numeric for the shared drive, for example shared_files_s1
Fielddata.rootFolderId Typenumber DescriptionIdentifier of the storage root folder

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "name": "John Smith",
    "code": null,
    "module": "disk",
    "entityType": "user",
    "entityId": "1",
    "rootFolderId": 1
  }
}

Error response example

404 — storage not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Could not find entity with id '999999'."
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe storage with the given id does not exist or is not accessible to the user
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the disk scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

The full list of common API errors — Errors.

See also