Поля списка

Управляйте набором полей списка: получайте описания полей, создавайте новые, изменяйте и удаляйте. Справочник допустимых типов поля возвращает отдельная операция.

Битрикс24 API: lists.field.* Скоуп: lists

Поля списка

GET /v1/lists/:iblockId/fields

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

Параметры

Параметр Тип Обяз. Описание
iblockId (path) string да Идентификатор списка. Числовой IBLOCK_ID или символьный IBLOCK_CODE. Список — GET /v1/lists
iblockTypeId (query) string нет Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы

Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/fields \
  -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/121/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Идентификаторы полей:', Object.keys(data))

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

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

Поля ответа

Поле data — объект-справочник. Ключ верхнего уровня — идентификатор поля FIELD_ID, значение — описание этого поля. Ниже перечислены ключи описания.

Поле Тип Описание
success boolean Всегда true при успехе
data object Справочник полей, ключ — FIELD_ID, значение — описание поля
data.<FIELD_ID>.FIELD_ID string Идентификатор поля. У пользовательских — PROPERTY_<число>, у системных — символьный код, например NAME
data.<FIELD_ID>.NAME string Название поля для отображения
data.<FIELD_ID>.TYPE string Код типа поля. Расшифровка кодов — Типы полей
data.<FIELD_ID>.IS_REQUIRED string Обязательность заполнения: Y или N
data.<FIELD_ID>.MULTIPLE string Допускает несколько значений: Y или N
data.<FIELD_ID>.SORT number Порядок сортировки в форме
data.<FIELD_ID>.DEFAULT_VALUE string или null Значение по умолчанию
data.<FIELD_ID>.CODE string или null Символьный код поля. Есть только у пользовательских полей
data.<FIELD_ID>.ID string Числовой идентификатор пользовательского поля строкой. У системных полей отсутствует
data.<FIELD_ID>.PROPERTY_TYPE string или boolean Базовый тип пользовательского поля. У системных полей приходит false
data.<FIELD_ID>.SETTINGS object или boolean Параметры отображения поля в формах. У системных полей приходит false
data.<FIELD_ID>.IBLOCK_ID number Идентификатор списка, которому принадлежит поле

Пользовательские поля дополнительно содержат:

  • PROPERTY_USER_TYPE — расширенный тип пользовательского свойства, например привязка к CRM, дата или деньги. У системных полей приходит false.
  • LINK_IBLOCK_ID — идентификатор связанного списка для свойств-привязок. null, если поле не ссылается на другой список.
  • ROW_COUNT — высота поля ввода на форме в строках.
  • COL_COUNT — ширина поля ввода на форме в символах.
  • USER_TYPE_SETTINGS — дополнительные настройки пользовательского типа свойства. null, если их нет.

Поля-привязки к элементам дополнительно возвращают DISPLAY_VALUES_FORM — карту идентификаторов связанных элементов и их названий.

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

JSON 
{
  "success": true,
  "data": {
    "NAME": {
      "FIELD_ID": "NAME",
      "SORT": 20,
      "NAME": "Название",
      "IS_REQUIRED": "Y",
      "MULTIPLE": "N",
      "DEFAULT_VALUE": "",
      "TYPE": "NAME",
      "PROPERTY_TYPE": false,
      "PROPERTY_USER_TYPE": false,
      "SETTINGS": false,
      "IBLOCK_ID": 121
    },
    "PROPERTY_1149": {
      "FIELD_ID": "PROPERTY_1149",
      "SORT": 10,
      "NAME": "Приоритет",
      "IS_REQUIRED": "N",
      "MULTIPLE": "N",
      "DEFAULT_VALUE": "0",
      "TYPE": "N",
      "PROPERTY_TYPE": "N",
      "PROPERTY_USER_TYPE": false,
      "CODE": "PRIORITY",
      "ID": "1149",
      "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"
      },
      "IBLOCK_ID": 121
    }
  }
}

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

403 — нет прав на список либо списка с таким идентификатором нет:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Нет прав для просмотра и редактирования списка."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в список допустимых типов
403 BITRIX_ACCESS_DENIED Нет прав на просмотр списка либо списка с указанным идентификатором не существует
403 SCOPE_DENIED Ключу не хватает скоупа lists
401 TOKEN_MISSING У ключа нет настроенных токенов
409 LISTS_MODULE_NOT_ENABLED На портале не подключён модуль списков

Полный список общих ошибок API — Ошибки.

Известные особенности

Поля возвращаются объектом, а не массивом. Ключ верхнего уровня — идентификатор поля FIELD_ID. Чтобы перебрать все поля, используйте Object.values(data) или Object.keys(data). Порядок отображения в форме задаёт SORT.

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