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

Получить поле

GET /v1/lists/:iblockId/fields/:fieldId

Возвращает описание одного поля списка по его идентификатору. Подходит, когда нужны параметры конкретного поля, а не всего набора.

Параметры

Параметр	Тип	Обяз.	По умолч.	Описание
`iblockId` (path)	string	да	—	Идентификатор или символьный код списка. Значения — поля `ID` или `CODE` метода Список списков
`fieldId` (path)	string	да	—	Идентификатор поля из `FIELD_ID` метода Поля списка. У пользовательских полей — `PROPERTY_<число>`, у системных — символьный код, например `NAME`
`iblockTypeId` (query)	string	нет	`lists`	Тип инфоблока. Значения: `lists` — обычные списки `lists_socnet` — списки рабочих групп `bitrix_processes` — служебные бизнес-процессы `structure` — тип структуры компании, в котором находится штатный инфоблок графика отсутствий `absence`
`socnetGroupId` (query)	number	нет	—	Идентификатор рабочей группы для списков типа `lists_socnet`. Положительное целое число из поля `id` метода Список рабочих групп

Примеры

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

Terminal

curl https://vibecode.bitrix24.tech/v1/lists/153/fields/PROPERTY_1207 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal

curl https://vibecode.bitrix24.tech/v1/lists/153/fields/PROPERTY_1207 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/153/fields/PROPERTY_1207', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
const field = Object.values(data)[0]
console.log('Поле:', field.NAME)

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/153/fields/PROPERTY_1207', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле data содержит описание одного поля под ключом его типа. В пути data.<TYPE> вместо <TYPE> используется код типа, например N или S:HTML. У метода Поля списка ключом служит FIELD_ID. Поля meta в ответе нет.

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data`	object	Объект с единственным ключом — кодом типа поля. Значение — объект описания поля
`data.<TYPE>.FIELD_ID`	string	Идентификатор поля из метода Поля списка. У пользовательских полей — `PROPERTY_<число>`, у системных — символьный код, например `NAME`
`data.<TYPE>.NAME`	string	Название поля для отображения
`data.<TYPE>.TYPE`	string	Код типа поля. Расшифровка кодов — Типы полей
`data.<TYPE>.IS_REQUIRED`	string	Обязательность заполнения: `Y` или `N`
`data.<TYPE>.MULTIPLE`	string	Допускает несколько значений: `Y` или `N`
`data.<TYPE>.SORT`	number	Порядок сортировки в форме
`data.<TYPE>.DEFAULT_VALUE`	string, object или null	Значение по умолчанию. Формат зависит от `TYPE`: например, у `N` это строка с числом, у `S:HTML` — объект с ключами `TYPE` и `TEXT`
`data.<TYPE>.CODE`	string или null	Символьный код пользовательского поля. `null`, если не задан. У системных полей отсутствует
`data.<TYPE>.ID`	string	Числовой идентификатор пользовательского поля строкой — числовая часть `FIELD_ID`. У системных полей отсутствует
`data.<TYPE>.PROPERTY_TYPE`	string или boolean	Базовый тип пользовательского поля: `S`, `N`, `L`, `F`, `G` или `E`. У системных полей — `false`
`data.<TYPE>.PROPERTY_USER_TYPE`	object или boolean	Описание расширенного типа свойства. Содержит его базовый тип `PROPERTY_TYPE`, код `USER_TYPE`, название `DESCRIPTION` и обработчики, состав которых зависит от типа. `false`, если расширенного типа нет
`data.<TYPE>.LINK_IBLOCK_ID`	string или null	Идентификатор связанного списка из поля `ID` метода Список списков. `null`, если связи нет. У системных полей отсутствует
`data.<TYPE>.ROW_COUNT`	string	Высота поля ввода в строках. У системных полей отсутствует
`data.<TYPE>.COL_COUNT`	string	Ширина поля ввода в символах. У системных полей отсутствует
`data.<TYPE>.USER_TYPE_SETTINGS`	object или null	Настройки расширенного типа свойства. Состав зависит от `TYPE`, например `height` у `S:HTML`. `null`, если настроек нет. У системных полей отсутствует
`data.<TYPE>.SETTINGS`	object или boolean	Настройки отображения поля в формах. `false`, если настройки не заданы. Объект возможен и у системного поля
`data.<TYPE>.SETTINGS.SHOW_ADD_FORM`	string	Показывать поле при добавлении элемента: `Y` или `N`
`data.<TYPE>.SETTINGS.SHOW_EDIT_FORM`	string	Показывать поле при изменении элемента: `Y` или `N`
`data.<TYPE>.SETTINGS.ADD_READ_ONLY_FIELD`	string	Поле доступно только для чтения при добавлении элемента: `Y` или `N`
`data.<TYPE>.SETTINGS.EDIT_READ_ONLY_FIELD`	string	Поле доступно только для чтения при изменении элемента: `Y` или `N`
`data.<TYPE>.SETTINGS.SHOW_FIELD_PREVIEW`	string	Показывать поле при предварительном просмотре элемента: `Y` или `N`
`data.<TYPE>.DISPLAY_VALUES_FORM`	object или array	Варианты выбора для типов `L`, `G`, `E` и `E:...`: ключ — идентификатор варианта, раздела или элемента, значение — название. Если вариантов нет, приходит пустой массив `[]`

Чтобы получить описание поля, используйте Object.values(data)[0].

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

JSON

{
  "success": true,
  "data": {
    "N": {
      "FIELD_ID": "PROPERTY_1207",
      "SORT": 20,
      "NAME": "Приоритет",
      "IS_REQUIRED": "N",
      "MULTIPLE": "N",
      "DEFAULT_VALUE": "0",
      "TYPE": "N",
      "PROPERTY_TYPE": "N",
      "PROPERTY_USER_TYPE": false,
      "CODE": "PRIORITY",
      "ID": "1207",
      "LINK_IBLOCK_ID": null,
      "ROW_COUNT": "1",
      "COL_COUNT": "30",
      "USER_TYPE_SETTINGS": null,
      "SETTINGS": {
        "SHOW_ADD_FORM": "Y",
        "SHOW_EDIT_FORM": "Y",
        "ADD_READ_ONLY_FIELD": "N",
        "EDIT_READ_ONLY_FIELD": "N",
        "SHOW_FIELD_PREVIEW": "N"
      }
    }
  }
}

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

404 — поле не найдено: