## Поля типа смарт-процесса

`GET /v1/smart-processes/fields`

Возвращает описание полей типа смарт-процесса: какие можно передавать при создании и обновлении, какие доступны только на чтение.

## Примеры

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

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

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

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

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

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

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

| Поле | Тип | RO | Описание |
|------|-----|:--:|---------|
| `id` | number | да | Внутренний ID записи типа |
| `entityTypeId` | number | | ID типа сущности. Передаётся в `/v1/items/:entityTypeId` для работы с элементами. Если не передан при создании — Битрикс24 назначает свободное значение автоматически |
| `title` | string | | Название типа смарт-процесса |
| `code` | string \| null | | Символьный код типа (для программной идентификации). `null`, если не задан |
| `customSectionId` | number \| null | | ID цифрового рабочего места, к которому привязан тип. `null`, если не привязан. Записывается при создании, но не обновляется |
| `isCategoriesEnabled` | boolean | | Использовать в смарт-процессе свои воронки и туннели продаж |
| `isStagesEnabled` | boolean | | Использовать в смарт-процессе свои стадии и канбан |
| `isBeginCloseDatesEnabled` | boolean | | Поля «Дата начала» и «Дата завершения» |
| `isClientEnabled` | boolean | | Поле «Клиент» с привязкой к контактам и компаниям |
| `isLinkWithProductsEnabled` | boolean | | Привязка товаров каталога |
| `isMycompanyEnabled` | boolean | | Поле «Реквизиты вашей компании» |
| `isObserversEnabled` | boolean | | Поле «Наблюдатели» |
| `isSourceEnabled` | boolean | | Поля «Источник» и «Дополнительно об источнике» |
| `isAutomationEnabled` | boolean | | Роботы и триггеры |
| `isBizProcEnabled` | boolean | | Дизайнер бизнес-процессов |
| `isDocumentsEnabled` | boolean | | Печать документов |
| `isRecyclebinEnabled` | boolean | | Использование корзины |
| `isSetOpenPermissions` | boolean | | Делать новые воронки доступными для всех |
| `isUseInUserfieldEnabled` | boolean | | Использовать смарт-процесс в пользовательском поле |
| `isRecurringEnabled` | boolean | | Поле «Регулярность» |
| `isPaymentsEnabled` | boolean | | Онлайн-оплата |
| `isCountersEnabled` | boolean | | Счётчики (уведомления и бейджи) |
| `isInitialized` | boolean | да | Тип полностью инициализирован в портале |
| `createdBy` | number | да | Кем создан. Поиск: `GET /v1/users` |
| `updatedBy` | number | да | Кем изменён. Поиск: `GET /v1/users` |
| `createdTime` | datetime | да | Дата создания |
| `updatedTime` | datetime | да | Дата изменения |

Ответ также содержит массив `aggregatable` — поля, по которым доступна группировка в [агрегации](/docs/entities/smart-processes/aggregate), и массив `batch` со списком операций, доступных для пакетной обработки: `create`, `update`, `delete`.

> **Формат datetime.** `createdTime`/`updatedTime` приходят в ISO 8601, но конкретное представление (со смещением `+03:00` либо UTC `…Z` с миллисекундами) зависит от портала — парсьте как ISO 8601, не сравнивайте строки побайтно.

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

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "Внутренний ID", "description": "Внутренний числовой идентификатор записи типа смарт-процесса." },
      "entityTypeId": { "type": "number", "readonly": false, "label": "ID типа сущности", "description": "Идентификатор типа смарт-процесса, используемый в /v1/items/:entityTypeId; назначается автоматически, если не передан при создании." },
      "title": { "type": "string", "readonly": false, "label": "Название", "description": "Название типа смарт-процесса, отображаемое в интерфейсе Битрикс24." },
      "isCategoriesEnabled": { "type": "boolean", "readonly": false, "label": "Свои воронки", "description": "Включает собственные воронки и туннели продаж." },
      "isStagesEnabled": { "type": "boolean", "readonly": false, "label": "Свои стадии и канбан", "description": "Включает собственные стадии и канбан-доску." },
      "isLinkWithProductsEnabled": { "type": "boolean", "readonly": false, "label": "Привязка товаров", "description": "Включает привязку товаров каталога к элементам." },
      "code": { "type": "string", "readonly": false, "label": "Символьный код", "description": "Символьный код типа смарт-процесса; может отсутствовать (null)." },
      "createdBy": { "type": "number", "readonly": true, "label": "Кем создан", "description": "ID пользователя, создавшего тип смарт-процесса." },
      "customSectionId": { "type": "number", "readonly": false, "label": "Цифровое рабочее место", "description": "ID цифрового рабочего места, к которому привязан тип; задаётся только при создании и не обновляется." },
      "createdTime": { "type": "datetime", "readonly": true, "label": "Дата создания", "description": "Дата и время создания типа смарт-процесса." }
    },
    "aggregatable": ["customSectionId", "createdBy", "updatedBy", "isCategoriesEnabled", "isStagesEnabled", "isAutomationEnabled", "isBizProcEnabled", "isPaymentsEnabled", "isCountersEnabled", "isLinkWithProductsEnabled"],
    "batch": ["create", "update", "delete"]
  }
}
```

Показаны 10 полей из 27. Полный список — в таблице выше.

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

401 — ключ не передан:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 401 | `MISSING_API_KEY` | Заголовок `X-Api-Key` не передан |
| 401 | `INVALID_API_KEY` | Ключ не найден или отозван |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

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

## Известные особенности

**Вложенные структуры.** При создании и обновлении можно передавать поля `relations` (связи с другими типами CRM) и `linkedUserFields` (связанные пользовательские поля). Они не описаны в ответе `/fields`, но принимаются и сохраняются Битрикс24 без изменений. Подробнее — в [Создать тип](/docs/entities/smart-processes/create).

**Отличие от `GET /v1/{entity}/fields` у стандартных сущностей.** Этот эндпоинт описывает поля **типа смарт-процесса** (`crm.type.*`), а не элементов внутри него. Для полей элементов используйте `GET /v1/items/:entityTypeId/fields`.

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

- [Список типов](/docs/entities/smart-processes/list)
- [Создать тип](/docs/entities/smart-processes/create)
- [Обновить тип](/docs/entities/smart-processes/update)
- [Элементы смарт-процессов](/docs/entities/items)
- [Поля элементов](/docs/entities/items/fields)
- [Пользовательские поля](/docs/userfields)
- [Лимиты и оптимизация](/docs/optimization)