Get a List of Storage Items: entity.item.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: entity

Who can execute the method: a user authorized in the application

The entity.item.get method retrieves a list of items from the application's data storage.

This method works only in the context of an application.

Method Parameters

Required parameters are marked with *

Name
type

Description

ENTITY*
string

Identifier of the application's data storage. Use the value specified when creating the storage.

You can obtain the identifier using the entity.get method.

SORT
object

Object format:

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

where:

  • field_n — sorting field
  • value_n — sorting direction: ASC or DESC

Refer to the Item Type section for a list of available sorting fields.

By default, {"ID":"ASC"} is used.

FILTER
object

Object format:

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

where:

  • field_n — filtering field
  • value_n — filter value

Refer to the Item Type section for a list of available filtering fields.

You can add prefixes to the keys field_n:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • = — equal (default)
  • != or ! — not equal
  • >< — range
  • !>< — not in range
  • % — LIKE
  • !% — NOT LIKE
  • ? — check for null/not null

start
integer

Pagination parameter.

The page size is fixed at 50 records.

The formula for obtaining the N-th page:
start = (N - 1) * 50

For more details, refer to the article Features of List Methods

Code Examples

How to Use Examples in Documentation

Example of retrieving storage items where:

  • ENTITY — storage identifier dish_v2
  • SORT — sorting by activity date and identifier
  • FILTER — date range of activity
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+01:00","<DATE_ACTIVE_FROM":"2026-04-01T00:00:00+01:00"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.item.get
        
try
        {
            const response = await $b24.callMethod(
                'entity.item.get',
                {
                    ENTITY: 'dish_v2',
                    SORT: {
                        DATE_ACTIVE_FROM: 'ASC',
                        ID: 'ASC',
                    },
                    FILTER: {
                        '>=DATE_ACTIVE_FROM': '2026-03-01T00:00:00+01:00',
                        '<DATE_ACTIVE_FROM': '2026-04-01T00:00:00+01:00',
                    },
                    start: 0,
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }
        
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+01:00',
                            '<DATE_ACTIVE_FROM' => '2026-04-01T00:00:00+01: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+01:00',
                    '<DATE_ACTIVE_FROM': '2026-04-01T00:00:00+01: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+01:00',
                    '<DATE_ACTIVE_FROM' => '2026-04-01T00:00:00+01:00',
                ],
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "ID": "2331",
                    "TIMESTAMP_X": "2026-03-25T12:29:06+01:00",
                    "MODIFIED_BY": "577",
                    "DATE_CREATE": "2026-03-25T12:29:06+01:00",
                    "CREATED_BY": "577",
                    "ACTIVE": "Y",
                    "DATE_ACTIVE_FROM": "",
                    "DATE_ACTIVE_TO": "",
                    "SORT": "500",
                    "NAME": "Test Item",
                    "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+01:00",
                "date_finish": "2026-03-25T12:29:06+01:00",
                "operating_reset_at": 1774431546,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
item[]

List of storage items

total
integer

Total number of items in the selection

next
integer

Offset for retrieving the next page (if available)

time
time

Information about the execution time of the request

Item Type

Name
type

Description

ID
integer

Identifier of the item

TIMESTAMP_X
datetime

Date and time of the last modification

MODIFIED_BY
integer

Identifier of the user who modified the item

DATE_CREATE
datetime

Date and time of creation

CREATED_BY
integer

Identifier of the user who created the item

ACTIVE
string

Active flag (Y or N)

DATE_ACTIVE_FROM
datetime | string

Start date of activity or empty string

DATE_ACTIVE_TO
datetime | string

End date of activity or empty string

SORT
integer

Sorting index

NAME
string

Name of the item

PREVIEW_PICTURE
string | null

URL of the preview image

PREVIEW_TEXT
string | null

Preview text

DETAIL_PICTURE
string | null

URL of the detailed image

DETAIL_TEXT
string | null

Detailed text

CODE
string | null

Symbolic code of the item

ENTITY
string

Identifier of the storage

SECTION
integer | null

Identifier of the section

PROPERTY_VALUES
object

Object of property values in the format {"CODE": value}. The field is present if the storage has properties.

You can obtain a list of available property codes using the entity.item.property.get method.

Error Handling

HTTP Status: 400

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

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

Value

ERROR_ARGUMENT

Argument 'ENTITY' is null or empty

The ENTITY parameter is not provided or is empty after cleanup.

ERROR_ARGUMENT

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

The ENTITY value is too long.

ERROR_ARGUMENT

Filter validator errors

Invalid values were provided for the FILTER parameter.

ERROR_ENTITY_NOT_FOUND

Entity not found

The storage with the provided ENTITY was not found.

ACCESS_DENIED

Access denied! Application context required

No application context (clientId).

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Update Storage Element
Next
Delete Storage Element