## Поля раздела

`GET /v1/catalog-sections/fields`

Возвращает справочник полей раздела каталога с типами, признаками «только для чтения» и «допускает `null`», а также список операций, доступных в пакетном запросе.

## Примеры

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

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

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

```bash
curl "https://vibecode.bitrix24.tech/v1/catalog-sections/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/catalog-sections/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/catalog-sections/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

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

`data.fields` — объект, ключ которого совпадает с именем поля, а значение содержит `type` (тип поля), `readonly` (`true` — поле нельзя передать при создании и обновлении) и `nullable` (присутствует, если поле может прийти со значением `null`). `data.batch` — список операций, которые принимает [пакетный запрос](/docs/batch).

| Поле | Тип | RO | Описание |
|------|-----|:--:|---------|
| `id` | number | да | Идентификатор раздела |
| `iblockId` | number | нет | ID каталога, которому принадлежит раздел. Список: [`GET /v1/catalogs`](/docs/entities/catalogs) |
| `iblockSectionId` | number \| null | нет | ID родительского раздела. `null` — раздел верхнего уровня |
| `name` | string | нет | Название раздела |
| `xmlId` | string \| null | нет | Внешний идентификатор. `null`, если не задан |
| `code` | string \| null | нет | Символьный код раздела. `null`, если не задан |
| `sort` | number | нет | Индекс сортировки |
| `active` | boolean | нет | Активен ли раздел |
| `description` | string \| null | нет | Описание раздела. `null`, если не задано |
| `descriptionType` | string | нет | Формат описания: `text` или `html` |

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.fields.<имя>.type` | string | Тип поля: `number`, `string`, `boolean`, `datetime` |
| `data.fields.<имя>.readonly` | boolean | `true` — поле заполняется системой и не принимается при создании и обновлении |
| `data.fields.<имя>.nullable` | boolean | `true` — поле может прийти со значением `null`. Ключ присутствует только у таких полей |
| `data.batch` | string[] | Операции раздела, доступные в [пакетном запросе](/docs/batch): `create`, `update`, `delete` |

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

Каждое поле, помимо `type` и `readonly`, содержит `label` (короткое название) и `description` (пояснение) на русском языке. Заголовками запроса язык не переключается. В примере ниже они опущены для краткости.

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "iblockId": { "type": "number", "readonly": false },
      "iblockSectionId": { "type": "number", "readonly": false, "nullable": true },
      "name": { "type": "string", "readonly": false },
      "xmlId": { "type": "string", "readonly": false, "nullable": true },
      "code": { "type": "string", "readonly": false, "nullable": true },
      "sort": { "type": "number", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "description": { "type": "string", "readonly": false, "nullable": true },
      "descriptionType": { "type": "string", "readonly": false }
    },
    "batch": ["create", "update", "delete"]
  }
}
```

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

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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `catalog` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |

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

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

- [Список разделов](/docs/entities/catalog-sections/list)
- [Создать раздел](/docs/entities/catalog-sections/create)
- [Поиск разделов](/docs/entities/catalog-sections/search)
- [Каталоги](/docs/entities/catalogs)
- [Справочник сущностей](/docs/entities-index)