
## Поля хранилища

`GET /v1/storages/fields`

Возвращает карту всех полей хранилища с типом и признаком только для чтения. Все поля хранилища доступны только для чтения — раздел не поддерживает создание и обновление.

## Примеры

### curl — личный ключ

```bash
curl "https://vibecode.bitrix24.tech/v1/storages/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl "https://vibecode.bitrix24.tech/v1/storages/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

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

const { success, data } = await res.json()
console.log('Полей:', Object.keys(data.fields).length)
```

### JavaScript — OAuth-приложение

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

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

## Поля ответа

Объект `data` содержит карту `fields` (имя поля → `{ type, readonly, label, description }`) и список `batch` с операциями массового режима. Для хранилищ `batch` пуст — раздел только для чтения.

Подписи полей `label` и `description` приходят на русском языке. Заголовками запроса язык не переключается.

| Поле | Битрикс24 | Тип | RO | Описание |
|------|----------|-----|:--:|---------|
| `id` | `ID` | number | да | Идентификатор хранилища |
| `name` | `NAME` | string | да | Название хранилища |
| `code` | `CODE` | string \| null | да | Символьный код. На проверенных порталах `null` |
| `module` | `MODULE_ID` | string | да | Модуль-владелец хранилища, для Диска — `disk` |
| `entityType` | `ENTITY_TYPE` | string | да | Тип владельца: `user`, `group`, `common` |
| `entityId` | `ENTITY_ID` | string | да | Идентификатор владельца. Строка, у общего диска нечисловая, например `shared_files_s1` |
| `rootFolderId` | `ROOT_OBJECT_ID` | number | да | Идентификатор корневой папки хранилища. Содержимое — [`GET /v1/folders`](/docs/entities/folders) |

## Пример ответа

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID", "description": "Уникальный идентификатор хранилища Диска." },
      "name": { "type": "string", "readonly": true, "label": "Название", "description": "Название хранилища, отображаемое пользователю." },
      "code": { "type": "string", "readonly": true, "label": "Символьный код", "description": "Символьный код хранилища; на практике часто отсутствует (null)." },
      "entityType": { "type": "string", "readonly": true, "label": "Тип владельца", "description": "Тип владельца хранилища — пользователь, группа или общий диск компании." },
      "entityId": { "type": "string", "readonly": true, "label": "ID владельца", "description": "Идентификатор владельца хранилища; для общего диска может быть нечисловым значением." },
      "rootFolderId": { "type": "number", "readonly": true, "label": "Корневая папка", "description": "ID корневой папки хранилища, с которой начинается его содержимое." },
      "module": { "type": "string", "readonly": true, "label": "Модуль", "description": "Код модуля-владельца хранилища; для Диска — значение disk." }
    },
    "batch": []
  }
}
```

## Пример ответа при ошибке

403 — нет скоупа:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'disk' scope"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `disk` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Смотрите также

- [Список хранилищ](/docs/entities/storages/list)
- [Получить хранилище](/docs/entities/storages/get)
- [Хранилища](/docs/entities/storages)
- [Entity API](/docs/entity-api)
