Получить список элементов инфоблока iblock.element.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: iblock

Кто может выполнять метод: любой пользователь

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод iblock.element.list возвращает список элементов инфоблока с фильтрацией, сортировкой и постраничной навигацией.

Метод работает только с инфоблоками, у которых в административной панели задан «Символьный код API» и включен «Доступ через REST». В облачном Битрикс24 административной панели нет, поэтому задать эти настройки нельзя и метод возвращает ошибку. Подробнее — в ограничениях и особенностях раздела.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

filter*
array

Фильтр списка в формате REST 3.0: массив условий вида ["поле", "оператор", "значение"].

Фильтр обязателен и должен содержать условие на равенство по iblockId с положительным идентификатором инфоблока, например [["iblockId",14]]. Метод возвращает элементы только этого инфоблока.

Фильтровать можно по полям id, iblockId, name, iblockSectionId. Фильтр по properties и другим полям элемента не поддерживается.

Синтаксис фильтра описан в обзоре REST 3.0

select
array

Массив полей элемента, которые нужно вернуть в ответе.

Доступные поля:

  • id — идентификатор элемента
  • iblockId — идентификатор инфоблока
  • name — название элемента
  • iblockSectionId — идентификатор раздела инфоблока
  • properties — значения свойств элемента

По умолчанию: id, iblockId, name, iblockSectionId. Поле properties без select возвращается, только если у элемента заполнены свойства

order
object

Сортировка в формате {"поле": "направление"}, например {"id":"ASC"}.

Сортировать можно по полям id, name, iblockSectionId.

Возможные значения направления:

  • ASC — по возрастанию
  • DESC — по убыванию

pagination
object

Параметры постраничной навигации. Описание структуры объекта

Параметр pagination

Название
тип

Описание

limit
integer

Количество элементов на странице. Значения больше 1000 уменьшаются до 1000. Ноль, отрицательное и нечисловое значение вызывают ошибку.

По умолчанию: 50

page
integer

Номер страницы, начиная с 1. Смещение вычисляется как (page - 1) * limit. Если передан page, значение offset не учитывается

offset
integer

Количество записей, которые нужно пропустить от начала списка.

По умолчанию: 0

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/iblock.element.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["iblockId",14],["iblockSectionId",8]],"select":["id","name","properties"],"order":{"id":"ASC"},"pagination":{"limit":50}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/iblock.element.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["iblockId",14],["iblockSectionId",8]],"select":["id","name","properties"],"order":{"id":"ASC"},"pagination":{"limit":50},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/iblock.element.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type PropertyValue = {
  id: number
  value: string
  description: string | null
}

type ElementListResult = {
  items: Array<{
    id: number
    name: string
    properties: Record<string, PropertyValue | PropertyValue[]> | []
  }>
}

try {
  const response = await $b24.actions.v3.call.make<ElementListResult>({
    method: 'iblock.element.list',
    params: {
      filter: [
        ['iblockId', 14],
        ['iblockSectionId', 8],
      ],
      select: ['id', 'name', 'properties'],
      order: { id: 'ASC' },
      pagination: { limit: 50 },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    result.items.forEach(item => console.info(item.id, item.name))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listElements() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'iblock.element.list',
        params: {
          filter: [
            ['iblockId', 14],
            ['iblockSectionId', 8],
          ],
          select: ['id', 'name', 'properties'],
          order: { id: 'ASC' },
          pagination: { limit: 50 },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      result.items.forEach(item => console.info(item.id, item.name))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listElements)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.iblock.element.list(
        filter=[
            ["iblockId", 14],
            ["iblockSectionId", 8],
        ],
        select=["id", "name", "properties"],
        order={"id": "ASC"},
        pagination={"limit": 50},
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'iblock.element.list',
            [
                'filter' => [
                    ['iblockId', 14],
                    ['iblockSectionId', 8],
                ],
                'select' => ['id', 'name', 'properties'],
                'order' => ['id' => 'ASC'],
                'pagination' => ['limit' => 50],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'iblock.element.list',
    {
        filter: [
            ['iblockId', 14],
            ['iblockSectionId', 8],
        ],
        select: ['id', 'name', 'properties'],
        order: { id: 'ASC' },
        pagination: { limit: 50 },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'iblock.element.list',
    [
        'filter' => [
            ['iblockId', 14],
            ['iblockSectionId', 8],
        ],
        'select' => ['id', 'name', 'properties'],
        'order' => ['id' => 'ASC'],
        'pagination' => ['limit' => 50],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "iblock.element.list", b24.Params{
	"filter": []any{
		[]any{"iblockId", 14},
		[]any{"iblockSectionId", 8},
	},
	"select": []string{"id", "name", "properties"},
	"order": b24.Params{
		"id": "ASC",
	},
	"pagination": b24.Params{
		"limit": 50,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("iblock.element.list: %w", err)
}

var result struct {
	Items []struct {
		ID         int             `json:"id"`
		Name       string          `json:"name"`
		Properties json.RawMessage `json:"properties"`
	} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range result.Items {
	fmt.Println(item.ID, item.Name)
}

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 215,
                "name": "Кресло офисное",
                "properties": {
                    "COLOR": {
                        "id": 1043,
                        "value": "Черный",
                        "description": null
                    },
                    "SIZE": [
                        {
                            "id": 1044,
                            "value": "M",
                            "description": null
                        },
                        {
                            "id": 1045,
                            "value": "L",
                            "description": null
                        }
                    ]
                }
            },
            {
                "id": 216,
                "name": "Стол письменный",
                "properties": []
            }
        ]
    },
    "time": {
        "start": 1792670785,
        "finish": 1792670785.424705,
        "duration": 0.42470502853393555,
        "processing": 0,
        "date_start": "2026-10-22T15:06:25+03:00",
        "date_finish": "2026-10-22T15:06:25+03:00",
        "operating_reset_at": 1792671360,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с данными ответа

result.items
array

Массив элементов инфоблока на странице. Состав полей зависит от select. Описание полей

time
time

Информация о времени выполнения запроса

Общее количество записей метод не возвращает. Если в ответе меньше записей, чем limit, страница последняя.

Элемент items

Название
тип

Описание

id
integer

Идентификатор элемента

iblockId
integer

Идентификатор инфоблока

name
string

Название элемента

iblockSectionId
integer

Идентификатор раздела инфоблока. null, если элемент не привязан к разделу

properties
object

Значения свойств элемента. Ключ — символьный код свойства, значение — объект значения для одиночного свойства или массив таких объектов для множественного.

Если properties указано в select, а свойств у элемента нет, возвращается пустой массив []

Объект значения свойства

Название
тип

Описание

id
integer

Идентификатор значения свойства

value
string

Значение свойства

description
string

Описание значения. null, если описание не задано

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Unable to compile iblock entity.",
                "field": "iblockId"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

filter

Значение поля не может быть пустым

Передайте filter с условием по iblockId

filter

iblockId must be a positive integer.

Передайте в условии по iblockId положительный идентификатор инфоблока

iblockId

Iblock not found.

Инфоблока с таким идентификатором нет. Проверьте значение iblockId в фильтре

iblockId

Unable to compile iblock entity.

У инфоблока не задан символьный код API. Задайте его в административной панели. В облачном Битрикс24 это сделать нельзя

iblockId

Restricted iblock ID:#ID# (#API_CODE#)

У инфоблока выключен доступ через REST. Включите его в административной панели

#FIELD#

В DTO ElementDto в поле #FIELD# требуется наличие атрибута Sortable для такого запроса

Сортируйте только по полям id, name, iblockSectionId

Ошибка фильтра по обязательному полю

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

filter.iblockId

Требуется указать фильтр по обязательному полю iblockId

Добавьте в filter условие ["iblockId", N]

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select, filter

Неизвестное поле #FIELD# для сущности ElementDto

Укажите только поля из описания элемента items

Ошибка сортировки

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION

Поле

Описание ошибки

Как исправить

order

Не удается распознать выражение сортировки #ORDER#

Передайте направление ASC или DESC

Ошибка постраничной навигации

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Поле

Описание ошибки

Как исправить

pagination

Не удается распознать параметр пагинации #PAGINATION#

Передайте limit положительным числом, offset — неотрицательным числом, page — числом

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение