[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-userfields\u002Fcrm\u002Fget":3,"docs-tabs-userfields\u002Fcrm\u002Fget":6},{"content":4,"lastmod":5},"\n## Получить поле\n\n`GET \u002Fv1\u002Fuserfields\u002F:entity\u002F:id`\n\nВозвращает полное описание одного пользовательского поля CRM-сущности по числовому идентификатору.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `:entity` (path) | string | да | Сущность: `deals`, `leads`, `contacts`, `companies`, `quotes`, `requisites` |\n| `:id` (path) | number | да | Числовой идентификатор поля (из ответа [`GET \u002Fv1\u002Fuserfields\u002F:entity`](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Flist) или [`POST \u002Fv1\u002Fuserfields\u002F:entity`](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Fcreate)) |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fuserfields\u002Fdeals\u002F7115\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fuserfields\u002Fdeals\u002F7115\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fuserfields\u002Fdeals\u002F7115',\n  {\n    headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n  }\n)\nconst { success, data } = await res.json()\nconsole.log(data.fieldName, data.userTypeId)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fuserfields\u002Fdeals\u002F7115',\n  {\n    headers: {\n      'X-Api-Key': 'YOUR_APP_KEY',\n      'Authorization': 'Bearer USER_SESSION_TOKEN',\n    },\n  }\n)\nconst { success, data } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data` | object | Объект поля |\n| `data.id` | number | Числовой идентификатор поля |\n| `data.entityId` | string | Внутренний идентификатор сущности: `CRM_DEAL`, `CRM_LEAD`, `CRM_CONTACT`, `CRM_COMPANY`, `CRM_QUOTE`, `CRM_REQUISITE` |\n| `data.fieldName` | string | Системное имя поля в формате `UF_CRM_*` |\n| `data.userTypeId` | string | Тип поля. Список допустимых значений — [`GET \u002Fv1\u002Fuserfields\u002F:entity\u002Ftypes`](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Ftypes) |\n| `data.xmlId` | string\\|null | Внешний идентификатор для интеграций. Задаётся вручную при создании |\n| `data.sort` | string | Порядок сортировки в интерфейсе Битрикс24 |\n| `data.multiple` | string | Множественное поле: `\"Y\"` или `\"N\"` |\n| `data.mandatory` | string | Обязательное при заполнении: `\"Y\"` или `\"N\"` |\n| `data.showFilter` | string | Отображать в фильтре: `\"N\"` — нет, `\"I\"` — точное значение, `\"E\"` — маска, `\"S\"` — диапазон |\n| `data.showInList` | string | Показывать в списке записей: `\"Y\"` или `\"N\"` |\n| `data.editInList` | string | Разрешить редактирование прямо из списка: `\"Y\"` или `\"N\"` |\n| `data.isSearchable` | string | Участвует ли в полнотекстовом поиске: `\"Y\"` или `\"N\"` |\n| `data.settings` | object | Настройки поля, специфичные для `userTypeId`. Для `string` — `SIZE`, `ROWS`, `REGEXP`, `MIN_LENGTH`, `MAX_LENGTH`, `DEFAULT_VALUE`. Для других типов состав отличается |\n| `data.list` | array | Варианты для поля типа `enumeration`. Для остальных типов поле отсутствует. Каждый элемент содержит `ID`, `SORT`, `VALUE`, `DEF` (все значения — строки) и опционально `XML_ID` (строка; присутствует только если задан вручную или при импорте — у вариантов, созданных через API, ключа нет) |\n| `data.editFormLabel` | object | Подпись поля в форме редактирования — объект с ключами по языкам портала |\n| `data.listColumnLabel` | object | Заголовок столбца в списке записей — объект с ключами по языкам портала |\n| `data.listFilterLabel` | object | Подпись поля в фильтре — объект с ключами по языкам портала |\n| `data.errorMessage` | object | Сообщение об ошибке валидации — объект с ключами по языкам портала |\n| `data.helpMessage` | object | Подсказка под полем в форме — объект с ключами по языкам портала |\n\n## Пример ответа\n\nЯзыковые объекты (`editFormLabel`, `listColumnLabel`, `listFilterLabel`, `errorMessage`, `helpMessage`) приходят для всех языков портала. В примере оставлены три ключа для краткости.\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 7115,\n    \"entityId\": \"CRM_DEAL\",\n    \"fieldName\": \"UF_CRM_VIBE_DOC_1779951810\",\n    \"userTypeId\": \"string\",\n    \"xmlId\": null,\n    \"sort\": \"100\",\n    \"multiple\": \"N\",\n    \"mandatory\": \"N\",\n    \"showFilter\": \"N\",\n    \"showInList\": \"Y\",\n    \"editInList\": \"Y\",\n    \"isSearchable\": \"N\",\n    \"settings\": {\n      \"SIZE\": 20,\n      \"ROWS\": 1,\n      \"REGEXP\": \"\",\n      \"MIN_LENGTH\": 0,\n      \"MAX_LENGTH\": 0,\n      \"DEFAULT_VALUE\": \"\"\n    },\n    \"editFormLabel\": {\n      \"ru\": \"Документационное поле\",\n      \"en\": \"Документационное поле\",\n      \"de\": \"Документационное поле\"\n    },\n    \"listColumnLabel\": {\n      \"ru\": \"Документационное поле\",\n      \"en\": \"Документационное поле\",\n      \"de\": \"Документационное поле\"\n    },\n    \"listFilterLabel\": {\n      \"ru\": \"Документационное поле\",\n      \"en\": \"Документационное поле\",\n      \"de\": \"Документационное поле\"\n    },\n    \"errorMessage\": {\n      \"ru\": \"Документационное поле\",\n      \"en\": \"Документационное поле\",\n      \"de\": \"Документационное поле\"\n    },\n    \"helpMessage\": {\n      \"ru\": \"Документационное поле\",\n      \"en\": \"Документационное поле\",\n      \"de\": \"Документационное поле\"\n    }\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n404 — поле не существует:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"ENTITY_NOT_FOUND\",\n    \"message\": \"The entity with ID '9999999' is not found.\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `UNKNOWN_ENTITY` | `:entity` не входит в список поддерживаемых сущностей |\n| 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул ошибку NOT_FOUND — поля с таким `id` нет |\n| 404 | `NOT_FOUND` | Битрикс24 вернул успех, но `result` пустой — поле отсутствует на портале |\n| 401 | `MISSING_API_KEY` | Отсутствует заголовок `X-Api-Key` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Языковые объекты.** Поля `editFormLabel`, `listColumnLabel`, `listFilterLabel`, `errorMessage`, `helpMessage` приходят как объекты со значениями по языкам портала Битрикс24 (`ru`, `en`, `ua`, `de`, `fr` и другие). Значение устанавливается при создании или обновлении поля через параметр `label`. Если передать только строку (`\"label\": \"Мой заголовок\"`), Битрикс24 автоматически распространяет её на все доступные языки.\n\n**Поле `settings`.** Структура объекта `settings` зависит от значения `userTypeId`. Наборы ключей для распространённых типов:\n\n- `string` — `SIZE`, `ROWS`, `REGEXP`, `MIN_LENGTH`, `MAX_LENGTH`, `DEFAULT_VALUE`\n- `enumeration` — `DISPLAY`, `LIST_HEIGHT`, `CAPTION_NO_VALUE`, `SHOW_NO_VALUE`\n- `datetime` — `DEFAULT_VALUE`, `USE_SECOND`, `USE_TIMEZONE`\n\nДля других типов — свой набор ключей.\n\nТип вложенного ключа `settings.DEFAULT_VALUE` тоже зависит от `userTypeId`: пустая строка `\"\"` для `string` и `money`, число `0` для `boolean`, объект `{ \"TYPE\": ..., \"VALUE\": ... }` для `date` и `datetime`, пустой массив `[]` для `employee`. Состав и типы вложенных ключей `settings` не фиксированы — опирайтесь на конкретный `userTypeId`, а не на единый набор.\n\nЕсли у типа поля нет настраиваемых параметров, Битрикс24 может вернуть само поле `settings` пустым массивом `[]` вместо `{}` (особенность сериализации пустого ассоциативного массива в PHP). Трактуйте пустой массив как «настроек нет» — не полагайтесь на то, что `settings` всегда объект.\n\n## Смотрите также\n\n- [Список полей сущности](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Flist) — получить все поля с фильтрацией\n- [Каталог типов полей](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Ftypes) — расшифровка `userTypeId`\n- [Создать поле](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Fcreate) — добавить новое поле\n- [Обновить поле](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Fupdate) — изменить настройки поля\n- [Поля CRM-сущностей](\u002Fdocs\u002Fuserfields\u002Fcrm) — маппинг полей и поддерживаемые сущности\n- [Пользовательские поля](\u002Fdocs\u002Fuserfields) — обзор раздела\n","2026-07-07",{}]