[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-userfields\u002Fsmart-processes\u002Fget":3,"docs-tabs-userfields\u002Fsmart-processes\u002Fget":6},{"content":4,"lastmod":5},"\n## Получить поле\n\n`GET \u002Fv1\u002Fitems\u002F:entityTypeId\u002Fuserfields\u002F:id`\n\nВозвращает полное описание одного пользовательского поля смарт-процесса по числовому идентификатору.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `:entityTypeId` (path) | number | да | Идентификатор типа смарт-процесса. Источник: [`GET \u002Fv1\u002Fsmart-processes`](\u002Fdocs\u002Fentities\u002Fsmart-processes) — поле `entityTypeId` в каждом элементе массива `data` |\n| `:id` (path) | number | да | Числовой идентификатор поля (из ответа [`GET \u002Fv1\u002Fitems\u002F:entityTypeId\u002Fuserfields`](\u002Fdocs\u002Fuserfields\u002Fsmart-processes\u002Flist) или [`POST \u002Fv1\u002Fitems\u002F:entityTypeId\u002Fuserfields`](\u002Fdocs\u002Fuserfields\u002Fsmart-processes\u002Fcreate)) |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fitems\u002F174\u002Fuserfields\u002F8210\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fitems\u002F174\u002Fuserfields\u002F8210\" \\\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\u002Fitems\u002F174\u002Fuserfields\u002F8210',\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\u002Fitems\u002F174\u002Fuserfields\u002F8210',\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_\u003CtypeId>`, где `typeId` — внутренний последовательный идентификатор смарт-процесса (не совпадает с `entityTypeId` из пути) |\n| `data.fieldName` | string | Системное имя поля в формате `UF_CRM_\u003CtypeId>_\u003Cсуффикс>` |\n| `data.userTypeId` | string | Тип поля. Список допустимых значений — [`GET \u002Fv1\u002Fitems\u002F:entityTypeId\u002Fuserfields\u002Ftypes`](\u002Fdocs\u002Fuserfields\u002Fsmart-processes\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`. Состав ключей зависит от типа |\n| `data.languageId` | object | Языки портала: ключ и значение — код языка (`{ \"ru\": \"ru\", … }`) |\n| `data.editFormLabel` | object | Подпись поля в форме редактирования. Объект по языкам портала: значение в нужной локали, остальные — `\"\"` |\n| `data.listColumnLabel` | object | Заголовок столбца в списке записей. Объект по языкам; если не задан — значения `null` |\n| `data.listFilterLabel` | object | Подпись поля в фильтре. Объект по языкам; если не задан — значения `null` |\n| `data.errorMessage` | object | Сообщение об ошибке валидации. Объект по языкам; если не задан — значения `null` |\n| `data.helpMessage` | object | Подсказка под полем в форме. Объект по языкам; если не задан — значения `null` |\n| `data.enum` | array | Только для типа `enumeration`: варианты значений. Каждый элемент содержит `id`, `userFieldId`, `value`, `def`, `sort`, `xmlId` |\n\n## Пример ответа\n\nЯзыковые объекты (`languageId`, `editFormLabel`, `listColumnLabel`, `listFilterLabel`, `errorMessage`, `helpMessage`) приходят на все языки портала. В примере оставлен `ru` и `…` вместо остальных.\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"id\": 3351,\n    \"entityId\": \"CRM_3\",\n    \"fieldName\": \"UF_CRM_3_1628508893\",\n    \"userTypeId\": \"string\",\n    \"xmlId\": null,\n    \"sort\": \"100\",\n    \"multiple\": \"N\",\n    \"mandatory\": \"N\",\n    \"showFilter\": \"E\",\n    \"showInList\": \"Y\",\n    \"editInList\": \"Y\",\n    \"isSearchable\": \"Y\",\n    \"settings\": {\n      \"SIZE\": 20,\n      \"ROWS\": 1,\n      \"REGEXP\": \"\",\n      \"MIN_LENGTH\": 0,\n      \"MAX_LENGTH\": 0,\n      \"DEFAULT_VALUE\": \"\"\n    },\n    \"languageId\": { \"ru\": \"ru\", \"…\": \"…\" },\n    \"editFormLabel\": { \"ru\": \"Строка1\", \"…\": \"\" },\n    \"listColumnLabel\": { \"ru\": null, \"…\": null },\n    \"listFilterLabel\": { \"ru\": null, \"…\": null },\n    \"errorMessage\": { \"ru\": null, \"…\": null },\n    \"helpMessage\": { \"ru\": null, \"…\": null }\n  }\n}\n```\n\nДля поля типа `enumeration` в ответе дополнительно приходит массив `enum` с вариантами:\n\n```json\n\"enum\": [\n  { \"id\": \"1347\", \"userFieldId\": \"3929\", \"value\": \"1\", \"def\": \"N\", \"sort\": \"100\", \"xmlId\": \"a84972a4857b64f963b165785b3c20d0\" }\n]\n```\n\n## Пример ответа при ошибке\n\n403 — у ключа нет скоупа `userfieldconfig`:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"BITRIX_ACCESS_DENIED\",\n    \"message\": \"The request requires higher privileges than provided by the webhook token\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_ENTITY_TYPE_ID` | `:entityTypeId` не является положительным целым числом |\n| 403 | `BITRIX_ACCESS_DENIED` | У ключа нет скоупа `userfieldconfig` — перевыпустите ключ с этим скоупом |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |\n| 404 | `SMART_PROCESS_NOT_FOUND` | Смарт-процесс с указанным `entityTypeId` не найден на портале |\n| 422 | `BITRIX_ERROR` | Поля с указанным `id` нет (или оно удалено) — Битрикс24 отвечает «Вы не можете просматривать настройки пользовательских полей» |\n| 401 | `MISSING_API_KEY` | Отсутствует заголовок `X-Api-Key` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Несуществующее поле даёт `422`, а не `404`.** Если поля с указанным `id` нет (например, оно удалено), Битрикс24 отвечает `422 BITRIX_ERROR` с сообщением «Вы не можете просматривать настройки пользовательских полей» — отдельного `404` для поля не возвращается. `404 SMART_PROCESS_NOT_FOUND` относится только к несуществующему `entityTypeId`.\n\n## Смотрите также\n\n- [Список полей смарт-процесса](\u002Fdocs\u002Fuserfields\u002Fsmart-processes\u002Flist)\n- [Каталог типов полей](\u002Fdocs\u002Fuserfields\u002Fsmart-processes\u002Ftypes)\n- [Создать поле](\u002Fdocs\u002Fuserfields\u002Fsmart-processes\u002Fcreate)\n- [Обновить поле](\u002Fdocs\u002Fuserfields\u002Fsmart-processes\u002Fupdate)\n- [Поля смарт-процессов](\u002Fdocs\u002Fuserfields\u002Fsmart-processes)\n- [Пользовательские поля](\u002Fdocs\u002Fuserfields)\n","2026-07-07",{}]