Элементы списка

GET /v1/lists/:iblockId/elements

Возвращает элементы списка с фильтрацией и постраничным обходом.

Параметры

Параметр Тип Обяз. По умолч. Описание
iblockId (path) string да — Числовой идентификатор списка IBLOCK_ID или символьный код IBLOCK_CODE
iblockTypeId (query) string нет lists Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы
filter (query) string нет — JSON-объект фильтра по полям элемента. Ключ — имя поля, значение — условие. Пример: ?filter={"NAME":"%отчёт%"}
select (query) string нет — Список возвращаемых полей через запятую. Пользовательское свойство запрашивается как PROPERTY_<id>. Пример: ?select=ID,NAME,PROPERTY_1149
start (query) number нет 0 Смещение от начала выборки для постраничного обхода

Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/elements \
  -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/elements', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data, meta } = await res.json()
console.log(`Элементов: ${meta.total}`, data)

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив элементов списка
data[].ID string Идентификатор элемента
data[].NAME string Название элемента
data[].IBLOCK_SECTION_ID string или null Идентификатор раздела, null для элемента вне разделов
data[].PROPERTY_<id> object Значения пользовательского свойства. Ключ — идентификатор свойства из Поля списка. Форма значения — в разделе «Известные особенности»
meta.total number Общее количество элементов, соответствующих фильтру

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

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

JSON 
{
  "success": true,
  "data": [
    { "ID": "501", "NAME": "Пример элемента", "IBLOCK_SECTION_ID": null },
    { "ID": "502", "NAME": "Черновик", "IBLOCK_SECTION_ID": "12" }
  ],
  "meta": { "total": 2 }
}

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

403 — нет доступа к списку:

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

Ошибки

HTTP Код Описание
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в набор lists, bitrix_processes, lists_socnet
400 INVALID_FILTER Параметр filter не является корректным JSON
403 BITRIX_ACCESS_DENIED Нет доступа к списку или список с указанным iblockId не существует
409 LISTS_MODULE_NOT_ENABLED На портале не подключён модуль «Списки»
403 SCOPE_DENIED Ключу не хватает скоупа lists
401 TOKEN_MISSING У ключа не настроены токены доступа

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

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

Значения пользовательских свойств приходят под ключами PROPERTY_<id> в виде отображения «идентификатор значения — значение». Ту же форму подробно показывает Получить элемент.

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