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

Получить значение списочного поля

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

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

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

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

Параметры

Параметр Тип Обяз. По умолч. Описание
Параметрentity (path) Типstring Обяз.да По умолч.— Описаниеdeals — сделки, leads — лиды, contacts — контакты, companies — компании, quotes — предложения, invoices — счета
ПараметрentityTypeId (path) Типinteger Обяз.для альтернативного адреса По умолч.— ОписаниеИдентификатор типа смарт-процесса или 31 для счетов
Параметрid (path) Типinteger Обяз.да По умолч.— ОписаниеПоложительный идентификатор варианта из списка или ответа создания

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values/4119" \
  -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/4119',
  {
    "method": "GET",
    "headers": {
      "X-Api-Key": "YOUR_API_KEY"
    }
  }
)
const { success, data } = await response.json()

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

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

Поля ответа

HTTP 200 OK.

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata Типobject ОписаниеВариант поля
Полеdata.id Типinteger ОписаниеИдентификатор варианта для получения
Полеdata.fieldId Типinteger ОписаниеИдентификатор поля. См. поля CRM и поля смарт-процесса
Полеdata.value Типstring ОписаниеНазвание варианта
Полеdata.isDefault Типboolean ОписаниеИспользуется по умолчанию
Полеdata.sort Типinteger ОписаниеПорядок сортировки
Полеdata.xmlId Типstring / null ОписаниеВнешний идентификатор

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

JSON 
{
  "success": true,
  "data": {
    "id": 4119,
    "fieldId": 6008145,
    "value": "VIBE-PROBE option",
    "isDefault": false,
    "sort": 500,
    "xmlId": "VIBE-PROBE-X"
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive safe integer"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректная форма запроса или тип параметра
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный или повторённый параметр запроса
HTTP404 КодENTITY_NOT_FOUND ОписаниеВариант с указанным идентификатором не найден
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 — Ошибки.

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