#Универсальные списки

Программный доступ к модулю «Списки» Битрикс24: сами списки, их поля, разделы и элементы.

Скоуп: lists | Базовый URL: https://vibecode.bitrix24.tech/v1 | Авторизация: X-Api-Key

Модуль подключается на портале отдельно. Универсальные списки — отдельный модуль Битрикс24. Если он не активирован на портале, вызовы возвращают 409 LISTS_MODULE_NOT_ENABLED. Это не ошибка интеграции — попросите администратора портала включить модуль «Списки» и повторите запрос.

#Модель данных

Список — это инфоблок. Каждый вызов адресует данные тремя уровнями ключей.

Тип инфоблока — параметр iblockTypeId. Возможные значения:

• lists — обычные списки. Значение по умолчанию.
• lists_socnet — списки рабочих групп. Для них нужен socnetGroupId.
• bitrix_processes — служебные бизнес-процессы.

Тип передаётся в query для GET и DELETE, в теле для POST и PATCH.

Список — сегмент пути :iblockId. Одни цифры — это числовой IBLOCK_ID, строка — символьный код IBLOCK_CODE. Оба варианта равнозначны.

Поле, раздел или элемент — соответствующий вложенный сегмент пути.

Ответы приходят в форме Битрикс24. Ключи — в верхнем регистре через подчёркивание: ID, NAME, IBLOCK_TYPE_ID. Числовые идентификаторы возвращаются строками, например "ID": "121". Пользовательские свойства элемента адресуются ключами вида PROPERTY_<id>. Эти ключи не приводятся к camelCase — часть из них динамическая.

#Разделы документации

• Списки — создание, чтение, изменение и удаление самих списков, а также тип инфоблока.
• Поля списка — набор полей списка и справочник допустимых типов поля.
• Разделы — группировка элементов по разделам с поддержкой вложенности.
• Элементы — строки списка и ссылки на файлы из свойств элемента.

#Быстрый старт

# Все списки типа lists
curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://vibecode.bitrix24.tech/v1/lists?iblockTypeId=lists"

# Элементы списка 23
curl -H "X-Api-Key: YOUR_API_KEY" \
  "https://vibecode.bitrix24.tech/v1/lists/23/elements"

#Полный пример

Сценарий из пяти шагов: создать список, добавить поле, добавить элемент со значением этого поля, прочитать результат, удалить список.

KEY="YOUR_API_KEY"
BASE="https://vibecode.bitrix24.tech/v1"

# 1. Создать список → { "success": true, "data": { "id": 135 } }
curl -s -X POST -H "X-Api-Key: $KEY" -H "Content-Type: application/json" \
  -d '{"iblockCode":"demo_orders","fields":{"NAME":"Демо: заявки","SORT":100}}' \
  "$BASE/lists"

# 2. Добавить поле → { "success": true, "data": { "id": "PROPERTY_1179" } }
curl -s -X POST -H "X-Api-Key: $KEY" -H "Content-Type: application/json" \
  -d '{"fields":{"NAME":"Статус","TYPE":"S","CODE":"STATUS"}}' \
  "$BASE/lists/135/fields"

# 3. Добавить элемент со значением свойства → { "success": true, "data": { "id": 7043 } }
curl -s -X POST -H "X-Api-Key: $KEY" -H "Content-Type: application/json" \
  -d '{"elementCode":"row-1","fields":{"NAME":"Заявка №1","PROPERTY_1179":"новая"}}' \
  "$BASE/lists/135/elements"

# 4. Прочитать элементы → data[0] = { "ID": "7043", "NAME": "Заявка №1", "PROPERTY_1179": { "3811": "новая" } }
curl -s -H "X-Api-Key: $KEY" \
  "$BASE/lists/135/elements?select=ID,NAME,PROPERTY_1179"

# 5. Удалить список → HTTP 204 No Content (поля, разделы и элементы удаляются вместе с ним)
curl -s -X DELETE -H "X-Api-Key: $KEY" "$BASE/lists/135"

Поле создаётся с обязательным CODE. Значение свойства при создании передаётся строкой ("PROPERTY_1179": "новая"), а при чтении возвращается в форме { id_значения: значение }.

#Справочник эндпоинтов

#Коды ошибок

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

#Лимиты

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

• Списки
• Поля списка
• Разделы
• Элементы