[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-userfields\u002Fcrm\u002Flist":3,"docs-tabs-userfields\u002Fcrm\u002Flist":6},{"content":4,"lastmod":5},"\n## Список полей сущности\n\n`GET \u002Fv1\u002Fuserfields\u002F:entity`\n\nВозвращает список пользовательских полей CRM-сущности. Поддерживает фильтрацию по типу поля и по имени.\n\n## Параметры\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `:entity` (path) | string | да | Сущность: `deals`, `leads`, `contacts`, `companies`, `quotes`, `requisites` |\n| `userTypeId` (query) | string | нет | Фильтр по типу поля. Список допустимых значений — [`GET \u002Fv1\u002Fuserfields\u002F:entity\u002Ftypes`](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Ftypes). Пример: `?userTypeId=string` |\n| `fieldName` (query) | string | нет | Фильтр по имени поля в формате `UF_CRM_*`. Пример: `?fieldName=UF_CRM_PROJECT_CODE` |\n\nРезультат упорядочен по полю `sort` по возрастанию. Параметр сортировки не принимается.\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fuserfields\u002Fdeals?userTypeId=string\" \\\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?userTypeId=string\" \\\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?userTypeId=string',\n  {\n    headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n  }\n)\nconst { success, data, meta } = await res.json()\nconsole.log(`Полей типа string: ${meta.total}`)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch(\n  'https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fuserfields\u002Fdeals?userTypeId=string',\n  {\n    headers: {\n      'X-Api-Key': 'YOUR_APP_KEY',\n      'Authorization': 'Bearer USER_SESSION_TOKEN',\n    },\n  }\n)\nconst { success, data, meta } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data` | array | Массив полей сущности. Набор полей элемента совпадает с [карточкой поля](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Fget), КРОМЕ языковых подписей `editFormLabel`, `listColumnLabel`, `listFilterLabel`, `errorMessage`, `helpMessage` — их отдаёт только карточка `GET \u002F:entity\u002F:id` (см. «Известные особенности») |\n| `meta.total` | number | Общее количество полей, соответствующих фильтру |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 6737,\n      \"entityId\": \"CRM_DEAL\",\n      \"fieldName\": \"UF_CRM_66976FE34823A\",\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\": \"N\",\n      \"settings\": {\n        \"SIZE\": 20,\n        \"ROWS\": 1,\n        \"REGEXP\": \"\",\n        \"MIN_LENGTH\": 0,\n        \"MAX_LENGTH\": 0,\n        \"DEFAULT_VALUE\": \"\"\n      }\n    },\n    {\n      \"id\": 6739,\n      \"entityId\": \"CRM_DEAL\",\n      \"fieldName\": \"UF_CRM_66976FE35F480\",\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    }\n  ],\n  \"meta\": {\n    \"total\": 7\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n400 — неизвестная сущность:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"UNKNOWN_ENTITY\",\n    \"message\": \"Unsupported entity \\\"foobar\\\". Supported: deals, leads, contacts, companies, quotes, requisites\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `UNKNOWN_ENTITY` | `:entity` не входит в список поддерживаемых сущностей |\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 отдаёт их из `crm.\u003Centity>.userfield.list` только при заданном фильтре `LANG`, который этот эндпоинт не передаёт. За локализованными подписями обращайтесь к [карточке поля](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Fget) (`GET \u002Fv1\u002Fuserfields\u002F:entity\u002F:id`) — она возвращает их объектами с ключами по языкам портала. Остальные поля элемента списка идентичны карточке.\n\n**Объект `settings`.** Структура поля `settings` зависит от `userTypeId`. Для строки это `SIZE`, `ROWS`, `REGEXP`, `MIN_LENGTH`, `MAX_LENGTH`, `DEFAULT_VALUE`. Для других типов — другой набор ключей. Если у типа поля нет настраиваемых параметров, Битрикс24 может вернуть `settings` пустым массивом `[]` вместо `{}` (особенность сериализации пустого массива в PHP) — трактуйте такое значение как «настроек нет».\n\n**Пагинация отсутствует.** Эндпоинт возвращает все поля сущности без разбивки на страницы. `meta.total` отражает итоговое число полей в ответе.\n\n## Смотрите также\n\n- [Каталог типов полей](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Ftypes) — список допустимых `userTypeId`\n- [Получить поле](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Fget) — полная схема одного поля по `id`\n- [Создать поле](\u002Fdocs\u002Fuserfields\u002Fcrm\u002Fcreate) — добавить новое пользовательское поле\n- [Поля CRM-сущностей](\u002Fdocs\u002Fuserfields\u002Fcrm) — маппинг полей и поддерживаемые сущности\n- [Пользовательские поля](\u002Fdocs\u002Fuserfields) — обзор раздела\n","2026-07-07",{}]