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

Списки

Создавайте списки, получайте их метаданные, изменяйте настройки и удаляйте список целиком. Список — это инфоблок Битрикс24, адресуемый числовым IBLOCK_ID или символьным кодом.

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

Список списков

GET /v1/lists

Возвращает списки заданного типа инфоблока, доступные текущему API-ключу на портале Битрикс24.

Параметры

Параметр Тип Обяз. По умолч. Описание
iblockTypeId (query) string нет lists Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы
sort (query) string нет — Сортировка в формате ПОЛЕ:направление. Поля: ID, IBLOCK_TYPE, NAME, CODE, SORT, TIMESTAMP_X. Направление asc или desc. Пример: sort=NAME:asc
start (query) number нет 0 Смещение для постраничной выборки
offset (query) number нет 0 Синоним start. Применяется, когда start не передан
socnetGroupId (query) number нет — Идентификатор рабочей группы для типа lists_socnet

Битрикс24 возвращает до 50 списков за вызов. Для следующей страницы увеличивайте start на 50. Общее количество списков заданного типа — в meta.total.

Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists \
  -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', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data, meta } = await res.json()
console.log('Списков:', meta.total)

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

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

Поля ответа

Поля ответа — в форме Битрикс24: ключи в верхнем регистре через подчёркивание, числовые значения и флаги (Y/N) приходят строками, незаданные поля — null.

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив списков
data[].ID string Идентификатор списка IBLOCK_ID
data[].NAME string Название списка
data[].IBLOCK_TYPE_ID string Тип инфоблока
data[].CODE string Символьный код. Приходит null, если код не задан
data[].DESCRIPTION string Описание списка
data[].ACTIVE string Активность: Y или N
data[].SORT string Индекс сортировки
data[].TIMESTAMP_X string Дата последнего изменения
data[].BIZPROC string Доступны ли бизнес-процессы: Y или N
data[].ELEMENTS_NAME string Название элементов списка во множественном числе
data[].SECTIONS_NAME string Название разделов во множественном числе
meta.total number Общее количество списков заданного типа

Показаны основные поля. Объект списка содержит и другие поля метаданных инфоблока Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "ID": "121",
      "NAME": "Список задач",
      "IBLOCK_TYPE_ID": "lists",
      "CODE": "my_list",
      "DESCRIPTION": "Список для управления ежедневными задачами",
      "ACTIVE": "Y",
      "SORT": "600",
      "TIMESTAMP_X": "12/11/2025 11:40:53 am",
      "BIZPROC": "N",
      "ELEMENTS_NAME": "Пункты",
      "SECTIONS_NAME": "Категории"
    },
    {
      "ID": "117",
      "NAME": "Проекты",
      "IBLOCK_TYPE_ID": "lists",
      "CODE": "my_custom_list",
      "DESCRIPTION": "Список для отслеживания задач в проекте",
      "ACTIVE": "Y",
      "SORT": "500",
      "TIMESTAMP_X": "12/03/2025 10:34:00 am",
      "BIZPROC": "Y",
      "ELEMENTS_NAME": "Задачи",
      "SECTIONS_NAME": "Разделы"
    }
  ],
  "meta": { "total": 11 }
}

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

400 — недопустимый тип инфоблока:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_IBLOCK_TYPE",
    "message": "iblockTypeId must be one of: lists, bitrix_processes, lists_socnet (default: lists)."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в допустимый набор
400 INVALID_SORT_FIELD Поле или направление сортировки не поддерживается
409 LISTS_MODULE_NOT_ENABLED Модуль «Списки» не подключён на портале
403 SCOPE_DENIED У API-ключа нет скоупа lists
401 TOKEN_MISSING У API-ключа нет настроенных токенов

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

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

Не у каждого списка есть символьный код. Поле CODE приходит null, если код не задавали. Такой список адресуется в операциях над одним списком только числовым IBLOCK_ID.

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