## Поля справочника

`GET /v1/statuses/fields`

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

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/statuses/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/statuses/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/statuses/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/statuses/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data } = await res.json()
```


## Поля ответа

| Поле | Тип | RO | Описание |
|------|-----|:--:|---------|
| `id` | number | да | ID записи |
| `entityId` | string | | Тип справочника (DEAL_STAGE, SOURCE и др.) |
| `statusId` | string | | Символьный код значения |
| `name` | string | | Название |
| `nameInit` | string | | Исходное название |
| `sort` | number | | Сортировка |
| `color` | string | | Цвет (HEX) |
| `semantics` | string | | Семантика: `S` — успех, `F` — провал, `null` — в работе или без семантики |
| `system` | boolean | да | Системное значение (нельзя изменить/удалить) |
| `categoryId` | number | | ID воронки (для `entityId` вида `DEAL_STAGE_N`) |
| `extra` | object | да | Дополнительные данные справочников со стадиями — `STATUS`, `DEAL_STAGE`, `DEAL_STAGE_N`, `QUOTE_STATUS`. Вложенные ключи `SEMANTICS` и `COLOR`. У остальных справочников поле отсутствует |

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

`GET /v1/statuses/fields` возвращает описания полей под ключом `data.fields` (имена — camelCase, как в ответах API), где каждое поле — `{ type, readonly, label, description }`. Подписи есть у всех одиннадцати полей, включая служебное `extra`. Плюс `data.batch` со списком доступных batch-операций.

```json
{
  "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": "Исходное название, присвоенное при создании записи." },
      "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 — нет скоупа:

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

## Ошибки

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

Полный список ошибок — [Ошибки](/docs/errors).

## Известные особенности

**Ключ `SEMANTICS` внутри `extra` подробнее поля `semantics`.** Поле различает три состояния, вложенный ключ — четыре:

| `extra.SEMANTICS` | `semantics` | Состояние стадии |
|-------------------|-------------|------------------|
| `process` | `null` | Промежуточная стадия |
| `success` | `S` | Успешное завершение |
| `failure` | `F` | Провал |
| `apology` | `F` | Ещё одна финальная стадия провала |

Стадии `failure` и `apology` в поле `semantics` неразличимы — обе приходят как `F`. Если сценарий их различает, читайте `extra.SEMANTICS`.

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

- [Справочники CRM](/docs/entities/statuses)
- [Список справочников](/docs/entities/statuses/list)