Поля воронки

GET /v1/categories/:entityTypeId/fields

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

Параметры

Параметр Тип Описание
entityTypeId (path) number ID типа CRM-сущности. Сделки — 2, счета — 31, смарт-процессы — из GET /v1/smart-processes

Примеры

В примерах entityTypeId = 2 (сделки) — замените на нужный тип.

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

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

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

Terminal 
curl -X GET https://vibecode.bitrix24.tech/v1/categories/2/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/categories/2/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/categories/2/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Битрикс24 Тип RO Описание
id id number RO ID воронки. Для сделок основная воронка имеет id 0
entityTypeId entityTypeId number RO ID типа CRM-сущности, повторяет параметр пути
name name string Название воронки. Обязательно при создании
sort sort number Порядок сортировки
isDefault isDefault boolean RO Признак основной воронки. Только чтение — запись отклоняется с 400 READONLY_FIELD
code code string RO Символьный код. Только чтение — запись отклоняется с 400 READONLY_FIELD. В ответах list, get и search не возвращается
createdDate createdDate datetime RO Дата создания. Не возвращается в ответах list, get
originId ORIGIN_ID string Внешний идентификатор
originatorId ORIGINATOR_ID string Источник внешней привязки

Поле batch перечисляет операции, доступные через Batch-запросы: create, update, delete.

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityTypeId": { "type": "number", "readonly": true },
      "name": { "type": "string", "readonly": false },
      "sort": { "type": "number", "readonly": false },
      "isDefault": { "type": "boolean", "readonly": true },
      "code": { "type": "string", "readonly": true },
      "createdDate": { "type": "datetime", "readonly": true },
      "originId": { "type": "string", "readonly": false, "label": "ORIGIN_ID" },
      "originatorId": { "type": "string", "readonly": false, "label": "ORIGINATOR_ID" }
    },
    "batch": ["create", "update", "delete"]
  }
}

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

404 — тип не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Смарт-процесс не найден"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND entityTypeId не соответствует существующему типу CRM
422 BITRIX_ERROR Тип CRM не поддерживает воронки. Предложения 7 воронок не имеют
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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