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

Storage types

GET /v1/storages/types

Calls disk.storage.getTypes. Requires the disk scope. READONLY keys are allowed.

Examples

curl — personal key

Terminal 
curl -X GET 'https://vibecode.bitrix24.com/v1/storages/types' \
  -H 'X-Api-Key: YOUR_API_KEY'

curl — OAuth application

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

JavaScript — personal key

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/storages/types', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
console.log(result)

JavaScript — OAuth application

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/storages/types', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
console.log(result)

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionWhether the request succeeded
Fielddata.items Typestring[] DescriptionStorage types returned by Bitrix24

data.items contains the strings returned by Bitrix24, without platform additions. user is a personal drive, common the shared drive, and group a workgroup drive. Use these values in the entityType filter of GET /v1/storages.

The list is hardcoded in Bitrix24 and incomplete: storage listings may contain other types, for example, application storages. Do not treat this list as an exhaustive enum.

Response example

JSON 
{"success":true,"data":{"items":["user","common","group"]}}

Error response example

403 — the key lacks the disk scope:

JSON 
{"success":false,"error":{"code":"SCOPE_DENIED","message":"API key requires \"disk\" scope."}}

Errors

HTTP Code Description
HTTP403 CodeSCOPE_DENIED DescriptionMissing disk scope or Bitrix24 denied access
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionMissing disk scope or Bitrix24 denied access
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 business refusal or no list returned
HTTP422 CodeOPERATION_FAILED DescriptionBitrix24 business refusal or no list returned

Common refusals: Errors.

See also