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

GET /v1/items/:entityTypeId/fields

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

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

#Примеры

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

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

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

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

Terminal 
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 — личный ключ

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).length)

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

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

#Поля ответа

Поле Тип Только чтение Описание
id number да ID элемента
title string Название
xmlId string Внешний код
stageId string Стадия. Формат: DT{typeId}_{catId}:{stage}
categoryId number ID воронки
assignedById number Ответственный. Список: GET /v1/users
companyId number ID компании. Поиск: GET /v1/companies
contactId number ID контакта. Поиск: GET /v1/contacts
contactIds array да Привязанные контакты
opportunity number Сумма
currencyId string Валюта. Список: GET /v1/currencies
opened boolean Доступен для всех
begindate datetime Дата начала
closedate datetime Дата завершения
sourceId string Источник
observers array Наблюдатели
mycompanyId number ID своей компании
createdBy number да Создатель
updatedBy number да Последний редактор
movedBy number да Переместил стадию
createdTime datetime да Дата создания
updatedTime datetime да Дата изменения
movedTime datetime да Дата смены стадии

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

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

JSON 
{
  "success": true,
  "data": {
    "id": {
      "type": "integer",
      "isRequired": false,
      "isReadOnly": true,
      "title": "ID"
    },
    "title": {
      "type": "string",
      "isRequired": false,
      "isReadOnly": false,
      "title": "Название"
    },
    "ufCrm156_custom": {
      "type": "string",
      "isRequired": false,
      "isReadOnly": false,
      "title": "Пользовательское поле"
    },
    "parentId2": {
      "type": "integer",
      "isRequired": false,
      "isReadOnly": false,
      "title": "Сделка"
    }
  }
}

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

404 — не найден:

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

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
400 RESERVED_ENTITY_TYPE entityTypeId зарезервирован

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

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