Get Storage Parameters or List of Storages entity.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: any user upon application authorization

The entity.get method returns the parameters of the specified storage or a list of all storages of the application.

The method works only in the context of the 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.

If the parameter is provided, the method returns data only for that storage.

Allowed characters are a-z, A-Z, 0-9, _

Code Examples

How to Use Examples in Documentation

Example of retrieving parameters for a specific storage, where ENTITY is the identifier dish_v2.

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ENTITY":"dish_v2","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.get

try
        {
        	const response = await $b24.callMethod(
        		'entity.get',
        		{
        			ENTITY: 'dish_v2',
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.get',
                    [
                        'ENTITY' => 'dish_v2',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting entity: ' . $e->getMessage();
        }

BX24.callMethod(
            'entity.get',
            {
                ENTITY: 'dish_v2',
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'entity.get',
            [
                'ENTITY' => 'dish_v2',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "ID": "183",
                "IBLOCK_TYPE_ID": "rest_entity",
                "ENTITY": "dish_v2",
                "NAME": "Dishes v2"
            },
            "time": {
                "start": 1774270219,
                "finish": 1774270219.086362,
                "duration": 0.08636188507080078,
                "processing": 0,
                "date_start": "2026-03-23T15:50:19+01:00",
                "date_finish": "2026-03-23T15:50:19+01:00",
                "operating_reset_at": 1774270819,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `result`	Root element of the response. Contains the storage object or a list of storages
time `time`	Information about the request execution time

Type result

Name `type`	Description
`object` `entity`	Returned if the `ENTITY` parameter is provided
`entity[]`	Returned if the `ENTITY` parameter is not provided

Type entity

Name `type`	Description
ID `string`	Identifier of the storage
IBLOCK_TYPE_ID `string`	Identifier of the storage type
ENTITY `string`	Identifier of the storage provided by the application
NAME `string`	Name of the storage

Error Handling

HTTP Status: 400

{
            "error": "ERROR_ENTITY_NOT_FOUND",
            "error_description": "Entity not found"
        }

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Entity code is too long. Max length is 13 characters.",
            "argument": ""
        }

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 provided but is empty after cleaning
`ERROR_ARGUMENT`	Entity code is too long. Max length is 13 characters.	The `ENTITY` value is too long
`ERROR_ENTITY_NOT_FOUND`	Entity not found	Storage with the provided `ENTITY` 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

Modify Storage Parameters

Delete Storage

Get Storage Parameters or List of Storages entity.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Type resultType result

Type entityType entity

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning