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

GET /v1/smart-processes/fields

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

#Примеры

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

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

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

Terminal 
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()

#Поля ответа

Поле Тип RO Описание
id number да Внутренний ID записи типа
entityTypeId number ID типа сущности. Передаётся в /v1/items/:entityTypeId для работы с элементами. Если не передан при создании — Битрикс24 назначает свободное значение автоматически
title string Название типа смарт-процесса
code string Символьный код типа (для программной идентификации)
customSectionId number да ID цифрового рабочего места, к которому привязан тип
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 user да Кем создан. Поиск: GET /v1/users
updatedBy user да Кем изменён. Поиск: GET /v1/users
createdTime datetime Дата создания
updatedTime datetime Дата изменения

Ответ также содержит массив batch со списком операций, доступных для пакетной обработки: create, update, delete.

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityTypeId": { "type": "number", "readonly": false },
      "title": { "type": "string", "readonly": false },
      "isCategoriesEnabled": { "type": "boolean", "readonly": false },
      "isStagesEnabled": { "type": "boolean", "readonly": false },
      "isLinkWithProductsEnabled": { "type": "boolean", "readonly": false },
      "code": { "type": "string", "readonly": false, "label": "Символьный код" },
      "createdBy": { "type": "user", "readonly": true, "label": "Кем создан" },
      "customSectionId": { "type": "integer", "readonly": true, "label": "Цифровое рабочее место" },
      "createdTime": { "type": "datetime", "readonly": false, "label": "Дата создания" }
    },
    "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 — Ошибки.

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

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

label — локализованное название из Битрикс24. Для части полей возвращается поле label с русской надписью, которую Битрикс24 показывает в интерфейсе (например, createdBy.label = "Кем создан"). Удобно для построения собственных форм и списков.

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

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