Поля элемента смарт-процесса

GET /v1/items/:entityTypeId/fields

Возвращает описание всех полей для указанного типа смарт-процесса, включая пользовательские (ufCrmN_*) и родительские ссылки (parentIdN).

Набор полей зависит от entityTypeId — каждый тип смарт-процесса имеет собственные пользовательские поля.

Примеры

В примерах entityTypeId = 156 — замените на ID вашего смарт-процесса.

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

curl -X GET https://vibecode.bitrix24.tech/v1/items/156/fields \
  -H "X-Api-Key: YOUR_API_KEY"

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

curl -X GET https://vibecode.bitrix24.tech/v1/items/156/fields \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

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

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

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

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

Поля ответа

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

UTM-поля Битрикс24 отдаёт в list/get, но у элементов смарт-процессов не принимает их ни в теле запроса, ни в фильтре, ни в сортировке — поэтому они помечены «только чтение», а запрос с filter[utmSource] возвращает ошибку.

isManualOpportunity и isRecurring приходят от Битрикс24 строкой "Y"/"N" — платформа нормализует их в JSON-boolean на чтении (и принимает true/false на запись для isManualOpportunity), как и opened.

Пользовательские поля (ufCrmN_*) и родительские ссылки (parentIdN) зависят от конкретного смарт-процесса. Для полей типа enumeration ответ содержит массив items с доступными значениями.

Нульность. Многие поля приходят null, когда не заполнены — в частности xmlId, sourceDescription, lastActivityTime и UTM-поля (utmSource/utmMedium/utmCampaign/utmContent/utmTerm, если включены на портале). Типобезопасным клиентам (TS) объявляйте такие поля как T | null.

/fields отражает живой контракт Битрикс24, а не форму платформенных доков. Это сквозной проброс схемы полей Битрикс24 как есть: типы приходят в нотации Битрикс24 (number, string, boolean, datetime, double, enumeration, crm_contact, crm_status, user и другие), флаг — readonly (а не isReadOnly), у части полей есть label, отдельного isRequired или title нет. Привязанные контакты читаются и пишутся через contactId и contactIds. Служебное поле contacts из схемы Битрикс24 платформа в справочнике не показывает: значения по нему не приходит ни в списке, ни в карточке, а на запись Битрикс24 принимает только пустой массив — любое непустое значение он отклоняет ошибкой своего внутреннего слоя данных. Поле было бы обещанием, которое нечем выполнить. Системные поля, которые Битрикс24 отдаёт в list/get, но не описаны выше (taxValue, previousStageId, lastActivityBy, lastCommunication*), проходят сквозным проксированием. Поля из таблицы выше платформа описывает сама, поэтому у них есть label и description, написанные для чтения человеком.

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

{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "title": { "type": "string", "readonly": false },
      "stageId": { "type": "string", "readonly": false },
      "begindate": { "type": "datetime", "readonly": false },
      "ufCrm156_custom": { "type": "string", "readonly": false },
      "parentId156": { "type": "number", "readonly": false }
    }
  }
}

Поля приходят внутри data.fields. Объект ответа также содержит data.products (схема товарных строк), data.aggregatable (поля, доступные в агрегации) и data.batch.

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

404 — не найден:

{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

Полный список общих ошибок API — Ошибки.

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

• Создать элемент
• Список элементов
• Смарт-процессы
• Entity API