Для AI-агентов: markdown этой страницы — /docs-content/entities/deal-categories/fields.md индекс документации — /llms.txt

Поля воронки

GET /v1/deal-categories/fields

Возвращает описание всех полей воронки с типами и атрибутами.

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/deal-categories/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/deal-categories/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/deal-categories/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()

Поля ответа

Объект data содержит карту fields и список batch с операциями, доступными в массовом режиме. Каждое поле карты описано типом type, признаком readonly, подписью label и описанием description.

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

Поле Тип RO Описание
id number да ID воронки
name string Название
sort number Сортировка
isLocked boolean да Заблокирована ли воронка — недоступна на текущем тарифе
createdAt datetime да Дата создания

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID",
        "description": "Уникальный идентификатор воронки (категории) сделок."
      },
      "name": {
        "type": "string",
        "readonly": false,
        "label": "Название",
        "description": "Отображаемое название воронки."
      },
      "sort": {
        "type": "number",
        "readonly": false,
        "label": "Сортировка",
        "description": "Порядок сортировки среди воронок."
      },
      "isLocked": {
        "type": "boolean",
        "readonly": true,
        "label": "Заблокирована",
        "description": "Заблокирована ли воронка (недоступна на текущем тарифе)."
      },
      "createdAt": {
        "type": "datetime",
        "readonly": true,
        "label": "Дата создания",
        "description": "Когда воронка была создана."
      }
    },
    "batch": ["create", "update", "delete"]
  }
}

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

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING Не передан API-ключ

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

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