## Список значений списочного поля

`GET /v1/userfields/:entity/enum-values`

Получает варианты одного списочного пользовательского поля CRM, чтобы использовать их идентификаторы при заполнении записей.

> **Возможность в процессе раскатки.** Требуется обновление CRM после `26.2200.0` и включение администратором. Номер выпуска ещё не опубликован. До доступности — `422 METHOD_NOT_YET_AVAILABLE` с полем `error.release`.

Для полей смарт-процессов используйте тот же контракт по адресу `GET /v1/items/:entityTypeId/userfields/enum-values`. Счета доступны также через `entityTypeId=31`.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
| `entity` (path) | string | да | — | `deals` — сделки, `leads` — лиды, `contacts` — контакты, `companies` — компании, `quotes` — предложения, `invoices` — счета |
| `entityTypeId` (path) | integer | для альтернативного адреса | — | Идентификатор типа [смарт-процесса](/docs/entities/smart-processes/list) или `31` для счетов |
| `fieldId` (query) | integer / string | да | — | Идентификатор или код `UF_*` списочного поля. Источники: [поля CRM](/docs/userfields/crm/list), [поля смарт-процесса](/docs/userfields/smart-processes/list) |
| `limit` (query) | integer | нет | `50` | Положительное количество значений на странице, максимум `1000` |
| `offset` (query) | integer | нет | `0` | Неотрицательное смещение от начала списка |

Пагинация: увеличивайте `offset` на `limit`, пока не придёт неполная или пустая страница. Общее количество не вычисляется. Другие параметры запроса не принимаются.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values?fieldId=6008145" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values?fieldId=6008145" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const response = await fetch(
  'https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values?fieldId=6008145',
  {
    "method": "GET",
    "headers": {
      "X-Api-Key": "YOUR_API_KEY"
    }
  }
)
const { success, data, meta } = await response.json()
```

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

```javascript
const response = await fetch(
  'https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values?fieldId=6008145',
  {
    "method": "GET",
    "headers": {
      "X-Api-Key": "YOUR_APP_KEY",
      "Authorization": "Bearer USER_SESSION_TOKEN"
    }
  }
)
const { success, data, meta } = await response.json()
```

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

HTTP `200 OK`.

| Поле | Тип | Описание |
|---|---|---|
| `success` | boolean | `true` при успехе |
| `data` | array | Варианты поля |
| `data[].id` | integer | Идентификатор варианта для [получения](/docs/entities/crm-field-enum/get) |
| `data[].fieldId` | integer | Идентификатор поля. См. [поля CRM](/docs/userfields/crm/list) и [поля смарт-процесса](/docs/userfields/smart-processes/list) |
| `data[].value` | string | Название варианта |
| `data[].isDefault` | boolean | Используется по умолчанию |
| `data[].sort` | integer | Порядок сортировки |
| `data[].xmlId` | string / null | Внешний идентификатор |
| `meta.limit` | integer | Запрошенный размер страницы |
| `meta.offset` | integer | Смещение страницы |

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

```json
{
  "success": true,
  "data": [
    {
      "id": 4119,
      "fieldId": 6008145,
      "value": "VIBE-PROBE option",
      "isDefault": false,
      "sort": 500,
      "xmlId": "VIBE-PROBE-X"
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0
  }
}
```

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

400 — некорректный запрос:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_PARAMS",
    "message": "fieldId must name a field by positive ID or UF code"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|---|---|---|
| 400 | `INVALID_PARAMS` | Некорректная форма запроса или тип параметра |
| 400 | `UNKNOWN_FILTER_FIELD` | Неизвестный или повторённый параметр запроса |
| 400 | `MISSING_REQUIRED_PARAMS` | Не передан корректный `fieldId` |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Возможность ещё недоступна. Сведения об обновлении — в `error.release` |
| 502 | `BITRIX_UNAVAILABLE` | Некорректный ответ Битрикс24 |
| 401 | `MISSING_API_KEY` | Не передан `X-Api-Key` |
| 401 | `TOKEN_MISSING` | Нет токенов для обращения к Битрикс24 |
| 403 | `SCOPE_DENIED` | Ключу нужен скоуп `crm` |

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

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

- [Получить значение списочного поля](/docs/entities/crm-field-enum/get)
- [Создать значение списочного поля](/docs/entities/crm-field-enum/create)
- [Обновить значение списочного поля](/docs/entities/crm-field-enum/update)
- [Удалить значение списочного поля](/docs/entities/crm-field-enum/delete)
- [Значения списочных полей CRM](/docs/entities/crm-field-enum)