Get parameters of an element or a list of elements lists.element.get

Scope: lists

Who can execute the method: a user with "Read" access permission for the required list

The method lists.element.get returns an element or a list of elements.

Method parameters

Required parameters are marked with *

Name `type`	Description
IBLOCK_TYPE_ID* `string`	Identifier of the information block type. Possible values: `lists` — list information block type `bitrix_processes` — processes information block type `lists_socnet` — group lists information block type
IBLOCK_ID* `integer`	Identifier of the information block. The identifier can be obtained using the lists.get method
IBLOCK_CODE* `string`	Symbolic code of the information block. The code can be obtained using the lists.get method At least one of the parameters must be specified: `IBLOCK_ID` or `IBLOCK_CODE`
ELEMENT_ID `integer`	Identifier of the element. The identifier can be obtained using the lists.element.get method
ELEMENT_CODE `string`	Symbolic code of the element. The code can be obtained using the lists.element.get method To retrieve element data, at least one of the parameters must be specified: `ELEMENT_ID` or `ELEMENT_CODE`
SELECT `array`	Array containing a list of fields to select. If no fields are specified, all available fields are returned by default. Available fields: `ID` — element identifier `CODE` — element code `NAME` — element name `IBLOCK_SECTION_ID` — identifier of the section to which the element is added `CREATED_BY` — identifier of the user who created the element `CREATED_USER_NAME` — name of the user who created the element (deprecated) `ACTIVE_TO` — end date of activity (deprecated) `BP_PUBLISHED` — publication within the workflow (deprecated) `DATE_CREATE` — element creation date `PREVIEW_TEXT` — preview text (deprecated) `DETAIL_TEXT` — detailed text (deprecated) `SORT` — sorting `PREVIEW_TEXT_TYPE` — type of preview text (deprecated) `DETAIL_TEXT_TYPE` — type of detailed text (deprecated) `PROPERTY_PropertyId` — custom properties The property identifier can be obtained using the lists.field.get method.
FILTER [`object`]	Object for filtering element fields in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. The filterable field can take the following values: `NAME` — element name `IBLOCK_SECTION_ID` — identifier of the section to which the element is added `CREATED_BY` — identifier of the user who created the element `ACTIVE_TO` — end date of activity (deprecated) `BP_PUBLISHED` — publication within the workflow (deprecated) `DATE_CREATE` — element creation date `PREVIEW_TEXT` — preview text (deprecated) `DETAIL_TEXT` — detailed text (deprecated) `SORT` — sorting `PREVIEW_TEXT_TYPE` — type of preview text (deprecated) `DETAIL_TEXT_TYPE` — type of detailed text (deprecated) `PROPERTY_PropertyId` — custom properties The property identifier can be obtained using the lists.field.get method. An additional prefix can be assigned to the key to specify the filter behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `=` — exact match `!=`, `!` — not equal `@` — IN, an array is passed as the value `!@` — NOT IN, an array is passed as the value `%` — LIKE, substring search. The `%` character should not be passed in the filter value. The search looks for the substring in any position of the string `=%` — LIKE, substring search. The `%` character should be passed in the value. Examples: `"mol%"` — searches for values starting with "mol" `"%mol"` — searches for values ending with "mol" `"%mol%"` — searches for values where "mol" can be in any position `!%` — NOT LIKE, substring search. The `%` character should not be passed in the filter value. The search goes from both sides `!=%` — NOT LIKE, substring search. The `%` character should be passed in the value. Examples: `"mol%"` — searches for values not starting with "mol" `"%mol"` — searches for values not ending with "mol" `"%mol%"` — searches for values where the substring "mol" is not present in any position `=` — equal, exact match, used by default `!=` — not equal `!` — not equal If no element identifier is provided and no filtering conditions are set, all elements of the list will be returned
ELEMENT_ORDER `object`	Object for sorting element fields in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Sorting direction can take the following values: `asc` — ascending `desc` — descending Sorting of multiple properties and the following properties is not supported: `S:Money` — money type `PREVIEW_TEXT` `DETAIL_TEXT` `S:ECrm` — CRM element binding type `S:DiskFile` — File type (Drive) `IBLOCK_SECTION_ID`
start `integer`	Parameter used for managing pagination. The page size of results is always static — 50 records. To select the second page of results, the value `50` must be passed. To select the third page of results — the value `100`, and so on. The formula for calculating the `start` parameter value: `start = (N - 1) * 50`, where `N` — the number of the desired page

Code examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":47,"ELEMENT_ID":6999,"SELECT":["ID","CODE","NAME","IBLOCK_SECTION_ID","DATE_CREATE","PROPERTY_951","PROPERTY_1003"],"FILTER":{"NAME":"%Test%","<=DATE_CREATE":"2025-12-31",">=DATE_CREATE":"2025-01-01"},"ELEMENT_ORDER":{"NAME":"asc"},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.element.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":47,"ELEMENT_ID":6999,"SELECT":["ID","CODE","NAME","IBLOCK_SECTION_ID","DATE_CREATE","PROPERTY_951","PROPERTY_1003"],"FILTER":{"NAME":"%Test%","<=DATE_CREATE":"2025-12-31",">=DATE_CREATE":"2025-01-01"},"ELEMENT_ORDER":{"NAME":"asc"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.element.get

try {
            const response = await $b24.callMethod(
                'lists.element.get',
                {
                    IBLOCK_TYPE_ID: 'lists',
                    IBLOCK_ID: 47,
                    ELEMENT_ID: 6999,
                    SELECT: [
                        'ID',
                        'CODE',
                        'NAME',
                        'IBLOCK_SECTION_ID',
                        'DATE_CREATE',
                        'PROPERTY_951',
                        'PROPERTY_1003'
                    ],
                    FILTER: {
                        NAME: '%Test%',
                        '>=DATE_CREATE': '2025-01-01',
                        '<=DATE_CREATE': '2025-12-31'
                    },
                    ELEMENT_ORDER: {
                        NAME: 'asc'
                    },
                    start: 0
                }
            );
        
            const result = response.getData().result;
            console.log('Fetched elements:', result);
            processResult(result);
        } catch (error) {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.element.get',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_ID' => 47,
                        'ELEMENT_ID' => 6999,
                        'SELECT' => [
                            'ID',
                            'CODE',
                            'NAME',
                            'IBLOCK_SECTION_ID',
                            'DATE_CREATE',
                            'PROPERTY_951',
                            'PROPERTY_1003'
                        ],
                        'FILTER' => [
                            'NAME' => '%Test%',
                            '>=DATE_CREATE' => '2025-01-01',
                            '<=DATE_CREATE' => '2025-12-31'
                        ],
                        'ELEMENT_ORDER' => [
                            'NAME' => 'asc'
                        ],
                        'start' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching list element: ' . $e->getMessage();
        }

BX24.callMethod(
            "lists.element.get",
            {
                IBLOCK_TYPE_ID: 'lists',
                IBLOCK_ID: 47,
                ELEMENT_ID: 6999,
                SELECT: [
                    'ID',
                    'CODE',
                    'NAME',
                    `IBLOCK_SECTION_ID`,
                    'DATE_CREATE',
                    'PROPERTY_951',
                    'PROPERTY_1003'
                ],
                FILTER: {
                    NAME: '%Test%',
                    '>=DATE_CREATE': '2025-01-01',
                    '<=DATE_CREATE': '2025-12-31'
                },
                ELEMENT_ORDER: {
                    NAME: 'asc'
                },
                start: 0
            },
            function(res) {
                if (res.error()) {
                    console.error(res.error());
                } else {
                    console.log(res.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'lists.element.get',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_ID' => 47,
                'ELEMENT_ID' => 6999,
                'SELECT' => [
                    'ID',
                    'CODE',
                    'NAME',
                    'IBLOCK_SECTION_ID',
                    'DATE_CREATE',
                    'PROPERTY_951',
                    'PROPERTY_1003'
                ],
                'FILTER' => [
                    'NAME' => '%Test%',
                    '>=DATE_CREATE' => '2025-01-01',
                    '<=DATE_CREATE' => '2025-12-31'
                ],
                'ELEMENT_ORDER' => [
                    'NAME' => 'asc'
                ],
                'start' => 0
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response handling

HTTP status: 200

{
            "result": [
                {
                "ID": "6999",
                "NAME": "Test element",
                "IBLOCK_SECTION_ID": null,
                "CREATED_BY": "1269",
                "CODE": "test_element",
                "PROPERTY_951": {
                    "3743": "1269",
                    "3745": "1271"
                },
                "PROPERTY_1003": {
                    "3747": "12/31/2024 11:59:59 pm"
                }
                }
            ],
            "total": 1,
            "time": {
                "start": 1763656328,
                "finish": 1763656328.442951,
                "duration": 0.442950963973999,
                "processing": 0,
                "date_start": "2025-11-19T14:32:08+02:00",
                "date_finish": "2025-11-19T14:32:08+02:00",
                "operating_reset_at": 1763656928,
                "operating": 0
            }
        }

Returned data

Name `type`	Description
result `array`	Data of the element or an array of elements. The result depends on the SELECT parameter. An empty array means that there are no elements in the list, or the elements do not match the filter
total `integer`	Total number of elements
time `time`	Information about the execution time of the request

Error handling

HTTP status: 400

{
            "error":"ERROR_REQUIRED_PARAMETERS_MISSING",
            "error_description":"Required parameter is missing"
        }

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_REQUIRED_PARAMETERS_MISSING`	Required parameter `X` is missing	Required parameter is missing
`ERROR_IBLOCK_NOT_FOUND`	Iblock not found	Information block not found
`ACCESS_DENIED`	Access denied	Insufficient rights to read the element

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue learning

Update an Element

Delete an Element

Get parameters of an element or a list of elements lists.element.get

Method parametersMethod parameters

Code examplesCode examples

Response handlingResponse handling

Returned dataReturned data

Error handlingError handling

Possible error codesPossible error codes

Statuses and System Error CodesStatuses and System Error Codes

Continue learningContinue learning