Получить список элементов хранилища entity.item.get

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

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

Scope: entity

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

Метод entity.item.get получает список элементов хранилища данных приложения.

Метод работает только в контексте приложения.

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

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

Название
тип

Описание

ENTITY*
string

Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища.

Получить идентификатор можно методом entity.get

SORT
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }
        

где:

  • field_n — поле сортировки
  • value_n — направление сортировки: ASC или DESC

Список доступных полей для сортировки смотрите в разделе Тип item.

По умолчанию используется {"ID":"ASC"}

FILTER
object

Объект формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }
        

где:

  • field_n — поле фильтрации
  • value_n — значение фильтра

Список доступных полей для фильтрации смотрите в разделе Тип item.

К ключам field_n можно добавлять префиксы:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • = — равно (по умолчанию)
  • != или ! — не равно
  • >< — диапазон
  • !>< — не в диапазоне
  • % — LIKE
  • !% — NOT LIKE
  • ? — проверка на null/not null

start
integer

Параметр постраничной навигации.

Размер страницы фиксирован: 50 записей.

Формула для получения N-й страницы:
start = (N - 1) * 50

Подробнее в статье Особенности списочных методов

Примеры кода

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

Пример получения элементов хранилища, где:

  • ENTITY — идентификатор хранилища dish_v2
  • SORT — сортировка по дате активности и идентификатору
  • FILTER — диапазон дат активности
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ENTITY":"dish_v2","SORT":{"DATE_ACTIVE_FROM":"ASC","ID":"ASC"},"FILTER":{">=DATE_ACTIVE_FROM":"2026-03-01T00:00:00+03:00","<DATE_ACTIVE_FROM":"2026-04-01T00:00:00+03:00"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.item.get
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each item returned in result[]
        type EntityItem = {
          ID: string
          TIMESTAMP_X: ISODate
          MODIFIED_BY: string
          DATE_CREATE: ISODate
          CREATED_BY: string
          ACTIVE: string
          DATE_ACTIVE_FROM: ISODate | string
          DATE_ACTIVE_TO: ISODate | string
          SORT: string
          NAME: string
          PREVIEW_PICTURE: string | null
          PREVIEW_TEXT: string | null
          DETAIL_PICTURE: string | null
          DETAIL_TEXT: string | null
          CODE: string | null
          ENTITY: string
          SECTION: string | null
          PROPERTY_VALUES?: Record<string, unknown>
        }
        
        try {
          // entity.item.get returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<EntityItem[]>({
            method: 'entity.item.get',
            params: {
              ENTITY: 'dish_v2',
              SORT: {
                DATE_ACTIVE_FROM: 'ASC',
                ID: 'ASC',
              },
              FILTER: {
                '>=DATE_ACTIVE_FROM': '2026-03-01T00:00:00+03:00',
                '<DATE_ACTIVE_FROM': '2026-04-01T00:00:00+03:00',
              },
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Items count:', result.length, 'First item:', result[0])
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getEntityItems() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // entity.item.get returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'entity.item.get',
                params: {
                  ENTITY: 'dish_v2',
                  SORT: {
                    DATE_ACTIVE_FROM: 'ASC',
                    ID: 'ASC',
                  },
                  FILTER: {
                    '>=DATE_ACTIVE_FROM': '2026-03-01T00:00:00+03:00',
                    '<DATE_ACTIVE_FROM': '2026-04-01T00:00:00+03:00',
                  },
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Items count:', result.length, 'First item:', result[0])
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getEntityItems)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.item.get',
                    [
                        'ENTITY' => 'dish_v2',
                        'SORT' => [
                            'DATE_ACTIVE_FROM' => 'ASC',
                            'ID' => 'ASC',
                        ],
                        'FILTER' => [
                            '>=DATE_ACTIVE_FROM' => '2026-03-01T00:00:00+03:00',
                            '<DATE_ACTIVE_FROM' => '2026-04-01T00:00:00+03:00',
                        ],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting entity items: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'entity.item.get',
            {
                ENTITY: 'dish_v2',
                SORT: {
                    DATE_ACTIVE_FROM: 'ASC',
                    ID: 'ASC',
                },
                FILTER: {
                    '>=DATE_ACTIVE_FROM': '2026-03-01T00:00:00+03:00',
                    '<DATE_ACTIVE_FROM': '2026-04-01T00:00:00+03:00',
                },
            },
            (result) => {
                if (result.error()) {
                    console.error(result.error());
                    return;
                }
        
                console.info(result.data());
        
                if (result.more()) {
                    result.next();
                }
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'entity.item.get',
            [
                'ENTITY' => 'dish_v2',
                'SORT' => [
                    'DATE_ACTIVE_FROM' => 'ASC',
                    'ID' => 'ASC',
                ],
                'FILTER' => [
                    '>=DATE_ACTIVE_FROM' => '2026-03-01T00:00:00+03:00',
                    '<DATE_ACTIVE_FROM' => '2026-04-01T00:00:00+03:00',
                ],
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "2331",
                    "TIMESTAMP_X": "2026-03-25T12:29:06+03:00",
                    "MODIFIED_BY": "577",
                    "DATE_CREATE": "2026-03-25T12:29:06+03:00",
                    "CREATED_BY": "577",
                    "ACTIVE": "Y",
                    "DATE_ACTIVE_FROM": "",
                    "DATE_ACTIVE_TO": "",
                    "SORT": "500",
                    "NAME": "Тестовый элемент",
                    "PREVIEW_PICTURE": null,
                    "PREVIEW_TEXT": null,
                    "DETAIL_PICTURE": null,
                    "DETAIL_TEXT": null,
                    "CODE": null,
                    "ENTITY": "dish",
                    "SECTION": null
                }
            ],
            "total": 1,
            "time": {
                "start": 1774430946,
                "finish": 1774430946.627232,
                "duration": 0.6272320747375488,
                "processing": 0,
                "date_start": "2026-03-25T12:29:06+03:00",
                "date_finish": "2026-03-25T12:29:06+03:00",
                "operating_reset_at": 1774431546,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
item[]

Список элементов хранилища

total
integer

Общее количество элементов в выборке

next
integer

Смещение для получения следующей страницы (если есть)

time
time

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

Тип item

Название
тип

Описание

ID
integer

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

TIMESTAMP_X
datetime

Дата и время последнего изменения

MODIFIED_BY
integer

Идентификатор пользователя, изменившего элемент

DATE_CREATE
datetime

Дата и время создания

CREATED_BY
integer

Идентификатор пользователя, создавшего элемент

ACTIVE
string

Флаг активности (Y или N)

DATE_ACTIVE_FROM
datetime | string

Дата начала активности или пустая строка

DATE_ACTIVE_TO
datetime | string

Дата окончания активности или пустая строка

SORT
integer

Индекс сортировки

NAME
string

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

PREVIEW_PICTURE
string | null

URL картинки анонса

PREVIEW_TEXT
string | null

Текст анонса

DETAIL_PICTURE
string | null

URL детальной картинки

DETAIL_TEXT
string | null

Детальный текст

CODE
string | null

Символьный код элемента

ENTITY
string

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

SECTION
integer | null

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

PROPERTY_VALUES
object

Объект значений свойств в формате {"КОД_СВОЙСТВА": значение}. Поле присутствует, если у хранилища есть свойства.

Для фильтрации по значению свойства используйте ключ PROPERTY_<КОД_СВОЙСТВА>, например {"PROPERTY_PRICE": 100}.

Список доступных кодов свойств можно получить методом entity.item.property.get

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

HTTP-статус: 400

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument 'ENTITY' is null or empty",
            "argument": "ENTITY"
        }
        
{
            "error": "ERROR_ENTITY_NOT_FOUND",
            "error_description": "Entity not found"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

ERROR_ARGUMENT

Argument 'ENTITY' is null or empty

Параметр ENTITY не передан или пустой после очистки

ERROR_ARGUMENT

Entity code is too long. Max length is N characters.

Слишком длинное значение ENTITY

ERROR_ARGUMENT

Ошибки валидатора фильтра

Переданы невалидные значения параметра FILTER

ERROR_ENTITY_NOT_FOUND

Entity not found

Хранилище с переданным ENTITY не найдено

ACCESS_DENIED

Access denied! Application context required

Нет контекста приложения (clientId)

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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