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

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

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 Обяз.для альтернативного адреса По умолч.— ОписаниеИдентификатор типа смарт-процесса или 31 для счетов
ПараметрfieldId (query) Типinteger / string Обяз.да По умолч.— ОписаниеИдентификатор или код UF_* списочного поля. Источники: поля CRM, поля смарт-процесса
Параметрlimit (query) Типinteger Обяз.нет По умолч.50 ОписаниеПоложительное количество значений на странице, максимум 1000
Параметрoffset (query) Типinteger Обяз.нет По умолч.0 ОписаниеНеотрицательное смещение от начала списка

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

Примеры

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

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

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

Terminal 
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 ОписаниеИдентификатор варианта для получения
Полеdata[].fieldId Типinteger ОписаниеИдентификатор поля. См. поля CRM и поля смарт-процесса
Поле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 Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректная форма запроса или тип параметра
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный или повторённый параметр запроса
HTTP400 КодMISSING_REQUIRED_PARAMS ОписаниеНе передан корректный fieldId
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность ещё недоступна. Сведения об обновлении — в error.release
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеНекорректный ответ Битрикс24
HTTP401 КодMISSING_API_KEY ОписаниеНе передан X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеНет токенов для обращения к Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеКлючу нужен скоуп crm

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

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