Для AI-агентов: markdown этой страницы — /docs-content/entities/statuses/fields.md индекс документации — /llms.txt
Поля справочника
GET /v1/statuses/fields
Возвращает описание всех полей сущности с типами и атрибутами.
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/statuses/fields" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/statuses/fields" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses/fields', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/statuses/fields', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { success, data } = await res.json()
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata.fields |
Типobject | ОписаниеСправочник полей записи. Ключ — имя поля в camelCase, как в ответах API, значение — его описание |
Полеdata.fields.<поле>.type |
Типstring | ОписаниеТип значения: number, string, boolean, object |
Полеdata.fields.<поле>.readonly |
Типboolean | ОписаниеПоле только для чтения |
Полеdata.fields.<поле>.label |
Типstring | ОписаниеПодпись поля |
Полеdata.fields.<поле>.description |
Типstring | ОписаниеПояснение к полю |
Полеdata.batch |
Типstring[] | ОписаниеОперации записи, доступные справочнику в пакетном вызове POST /v1/statuses/batch: create, update, delete — см. Batch |
Подписи label и description приходят на русском языке. Заголовками запроса язык не переключается.
Поля записи справочника, которые описывает data.fields:
| Поле | Тип | RO | Описание |
|---|---|---|---|
Полеid |
Типnumber | ROда | ОписаниеID записи |
ПолеentityId |
Типstring | RO | ОписаниеТип справочника (DEAL_STAGE, SOURCE и др.). Задаётся только при создании, PATCH не меняет |
ПолеstatusId |
Типstring | RO | ОписаниеСимвольный код значения. Задаётся только при создании, PATCH не меняет |
Полеname |
Типstring | RO | ОписаниеНазвание |
ПолеnameInit |
Типstring/null | RO | ОписаниеИсходное название |
Полеdescription |
Типstring/null | RO | ОписаниеОписание записи. Приходит не на всех порталах Битрикс24 — на таком портале поле приходит как null |
Полеsort |
Типnumber | RO | ОписаниеСортировка |
Полеcolor |
Типstring/null | RO | ОписаниеЦвет в HEX с ведущей # |
Полеsemantics |
Типstring/null | RO | ОписаниеСемантика: S — успех, F — провал. null — стадия «в работе» или справочник без семантики. Задаётся только при создании, PATCH не меняет |
Полеsystem |
Типboolean | ROда | ОписаниеСистемное значение, которое нельзя изменить или удалить |
ПолеcategoryId |
Типnumber/null | RO | ОписаниеID воронки. Заполняется для справочников вида DEAL_STAGE_N, иначе 0 или null. Определяется справочником entityId, PATCH не меняет |
Полеextra |
Типobject | ROда | ОписаниеДополнительные данные справочников со стадиями — STATUS, DEAL_STAGE, DEAL_STAGE_N, QUOTE_STATUS. Вложенные ключи SEMANTICS и COLOR. У остальных справочников поле отсутствует |
Пример ответа
{
"success": true,
"data": {
"fields": {
"id": { "type": "number", "readonly": true, "label": "ID", "description": "Уникальный числовой идентификатор записи справочника." },
"entityId": { "type": "string", "readonly": false, "label": "Тип справочника", "description": "Тип справочника, к которому относится запись (например, DEAL_STAGE, SOURCE, STATUS)." },
"statusId": { "type": "string", "readonly": false, "label": "Код значения", "description": "Символьный код значения внутри своего справочника." },
"name": { "type": "string", "readonly": false, "label": "Название", "description": "Отображаемое название записи." },
"nameInit": { "type": "string", "readonly": false, "label": "Исходное название", "description": "Исходное название, присвоенное при создании записи." },
"description": { "type": "string", "readonly": false, "label": "Описание", "description": "Текстовое описание записи. Поле есть не на всех порталах Битрикс24." },
"sort": { "type": "number", "readonly": false, "label": "Сортировка", "description": "Порядок сортировки внутри справочника." },
"color": { "type": "string", "readonly": false, "label": "Цвет", "description": "Цвет значения в формате HEX." },
"semantics": { "type": "string", "readonly": false, "label": "Семантика", "description": "Семантика стадии: S — успех, F — провал, null — в работе или без семантики." },
"system": { "type": "boolean", "readonly": true, "label": "Системное", "description": "Системное значение, которое нельзя изменить или удалить." },
"categoryId": { "type": "number", "readonly": false, "label": "ID воронки", "description": "ID воронки для значений entityId вида DEAL_STAGE_N." },
"extra": { "type": "object", "readonly": true, "label": "Дополнительные данные", "description": "Дополнительные данные стадийных справочников — объект с вложенными ключами SEMANTICS (семантика стадии) и COLOR (цвет стадии). Заполняется Битрикс24, только для чтения." }
},
"batch": ["create", "update", "delete"]
}
}
Пример ответа при ошибке
403 — нет скоупа:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'crm' scope"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP403 | КодSCOPE_DENIED |
ОписаниеAPI-ключ не имеет скоупа crm |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан заголовок X-Api-Key |
| HTTP429 | КодRATE_LIMITED |
ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After |
Полный список ошибок — Ошибки.
Известные особенности
Ключ SEMANTICS внутри extra подробнее поля semantics. Поле различает три состояния, вложенный ключ — четыре. Соответствие ниже верно для стадии, которая стоит по sort в своей группе:
extra.SEMANTICS |
semantics |
Состояние стадии |
|---|---|---|
extra.SEMANTICSprocess |
semanticsnull |
Состояние стадииПромежуточная стадия |
extra.SEMANTICSsuccess |
semanticsS |
Состояние стадииУспешное завершение |
extra.SEMANTICSfailure |
semanticsF |
Состояние стадииПровал |
extra.SEMANTICSapology |
semanticsF |
Состояние стадииЕщё одна финальная стадия провала |
Стадии failure и apology в поле semantics неразличимы — обе приходят как F. Если сценарий их различает, читайте extra.SEMANTICS.
extra.SEMANTICS следует за sort, а semantics — нет. Вложенный ключ вычисляется по положению стадии относительно успешной: стадия с semantics: "F", поставленная по sort перед успешной, отдаёт extra.SEMANTICS: "process", а поле semantics остаётся F. Поэтому сменой sort группу стадии не поменять. Как заменить стадию стадией другой группы, описано на странице Обновить запись справочника.