Get section parameters or list of sections using lists.section.get

Scope: lists

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

The method lists.section.get returns a section or a list of sections.

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: IBLOCK_ID or IBLOCK_CODE must be specified.

FILTER
object

Object for filtering sections {"field_1": "value_1", ... "field_N": "value_N"}. The filterable field can take the following values:

  • ID — section identifier
  • CODE — symbolic code of the section
  • XML_ID — external identifier (XML ID)
  • EXTERNAL_ID — external section identifier
  • NAME — section name
  • ACTIVE — activity status
  • GLOBAL_ACTIVE — global activity
  • IBLOCK_ACTIVE — information block activity status
  • IBLOCK_NAME — information block name
  • IBLOCK_TYPE — information block type identifier
  • IBLOCK_XML_ID — external identifier of the information block (XML ID)
  • IBLOCK_EXTERNAL_ID — external identifier of the information block
  • DEPTH_LEVEL — nesting level
  • LEFT_MARGIN — left boundary of the tree
  • RIGHT_MARGIN — right boundary of the tree
  • LEFT BORDER — left boundary
  • RIGHT BORDER — right boundary
  • TIMESTAMP_X — time of the last modification
  • DATE_CREATE — section creation date
  • CREATED_BY — identifier of the user who created the section
  • MODIFIED_BY — identifier of the user who modified the section

You can specify the type of filtering before the filterable field name:

  • ! — not equal
  • < — less than
  • <= — less than or equal to
  • > — greater than
  • >= — greater than or equal to
  • % — substring search

By default, records are not filtered.

SELECT
array

Array with fields to select. Available fields:

  • ID — section identifier
  • CODE — symbolic code of the section
  • XML_ID — external identifier (XML ID)
  • EXTERNAL_ID — external section identifier
  • IBLOCK_SECTION_ID — identifier of the parent section
  • TIMESTAMP_X — time of the last modification
  • SORT — sorting
  • NAME — section name
  • ACTIVE — activity status
  • GLOBAL_ACTIVE — global activity
  • PICTURE — picture (deprecated)
  • DESCRIPTION — description (deprecated)
  • DESCRIPTION_TYPE — description type (deprecated)
  • LEFT_MARGIN — left boundary of the tree
  • RIGHT_MARGIN — right boundary of the tree
  • DEPTH_LEVEL — nesting level
  • SEARCHABLE_CONTENT — searchable content
  • SECTION_PAGE_URL — page URL (deprecated)
  • MODIFIED_BY — identifier of the user who modified the section
  • DATE_CREATE — section creation date
  • CREATED_BY — identifier of the user who created the section
  • DETAIL_PICTURE — detailed picture (deprecated)

If no fields are specified, all available fields are returned by default.

To retrieve data for a single section, specify its identifier in FILTER. Without a filter, the method will return a list of all sections.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":95,"FILTER":{"ID":169,"ACTIVE":"Y","NAME":"%marketing%","<=DATE_CREATE":"2025-12-31",">=DATE_CREATE":"2025-01-01"},"SELECT":["ID","CODE","XML_ID","EXTERNAL_ID","IBLOCK_SECTION_ID","TIMESTAMP_X","SORT","NAME","ACTIVE","GLOBAL_ACTIVE","LEFT_MARGIN","RIGHT_MARGIN","DEPTH_LEVEL","SEARCHABLE_CONTENT","MODIFIED_BY","DATE_CREATE","CREATED_BY"]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.section.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":95,"FILTER":{"ID":169,"ACTIVE":"Y","NAME":"%marketing%","<=DATE_CREATE":"2025-12-31",">=DATE_CREATE":"2025-01-01"},"SELECT":["ID","CODE","XML_ID","EXTERNAL_ID","IBLOCK_SECTION_ID","TIMESTAMP_X","SORT","NAME","ACTIVE","GLOBAL_ACTIVE","LEFT_MARGIN","RIGHT_MARGIN","DEPTH_LEVEL","SEARCHABLE_CONTENT","MODIFIED_BY","DATE_CREATE","CREATED_BY"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.section.get
        
try
        {
            const response = await $b24.callMethod(
                'lists.section.get',
                {
                    IBLOCK_TYPE_ID: 'lists',
                    IBLOCK_ID: 95,
                    FILTER: {
                        ID: 169,
                        ACTIVE: 'Y',
                        NAME: '%marketing%',
                        '>=DATE_CREATE': '2025-01-01',
                        '<=DATE_CREATE': '2025-12-31'
                    },
                    SELECT: [
                        'ID',
                        'CODE',
                        'XML_ID',
                        'EXTERNAL_ID',
                        'IBLOCK_SECTION_ID',
                        'TIMESTAMP_X',
                        'SORT',
                        'NAME',
                        'ACTIVE',
                        'GLOBAL_ACTIVE',
                        'LEFT_MARGIN',
                        'RIGHT_MARGIN',
                        'DEPTH_LEVEL',
                        'SEARCHABLE_CONTENT',
                        'MODIFIED_BY',
                        'DATE_CREATE',
                        'CREATED_BY',
                    ]
                }
            );
            
            const result = response.getData().result;
            console.log('Retrieved sections:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.section.get',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_ID' => 95,
                        'FILTER' => [
                            'ID' => 169,
                            'ACTIVE' => 'Y',
                            'NAME' => '%marketing%',
                            '>=DATE_CREATE' => '2025-01-01',
                            '<=DATE_CREATE' => '2025-12-31'
                        ],
                        'SELECT' => [
                            'ID',
                            'CODE',
                            'XML_ID',
                            'EXTERNAL_ID',
                            'IBLOCK_SECTION_ID',
                            'TIMESTAMP_X',
                            'SORT',
                            'NAME',
                            'ACTIVE',
                            'GLOBAL_ACTIVE',
                            'LEFT_MARGIN',
                            'RIGHT_MARGIN',
                            'DEPTH_LEVEL',
                            'SEARCHABLE_CONTENT',
                            'MODIFIED_BY',
                            'DATE_CREATE',
                            'CREATED_BY',
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving section: ' . $e->getMessage();
        }
        
BX24.callMethod(
        'lists.section.get',
        {
            IBLOCK_TYPE_ID: 'lists',
            IBLOCK_ID: 95,
            
            FILTER: {
                'ID': 169,
                'ACTIVE': 'Y',
                'NAME': '%marketing%',
                '>=DATE_CREATE': '2025-01-01',
                '<=DATE_CREATE': '2025-12-31'
            },
        
            SELECT: [
                'ID',
                'CODE',
                'XML_ID',
                'EXTERNAL_ID',
                'IBLOCK_SECTION_ID',
                'TIMESTAMP_X',
                'SORT',
                'NAME',
                'ACTIVE',
                'GLOBAL_ACTIVE',
                'LEFT_MARGIN',
                'RIGHT_MARGIN',
                'DEPTH_LEVEL',
                'SEARCHABLE_CONTENT',
                'MODIFIED_BY',
                'DATE_CREATE',
                'CREATED_BY',
            ]
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.log(result.data());
            }
        }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'lists.section.get',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_ID' => 95,
                'FILTER' => [
                    'ID' => 169,
                    'ACTIVE' => 'Y',
                    'NAME' => '%marketing%',
                    '>=DATE_CREATE' => '2025-01-01',
                    '<=DATE_CREATE' => '2025-12-31'
                ],
                'SELECT' => [
                    'ID',
                    'CODE',
                    'XML_ID',
                    'EXTERNAL_ID',
                    'IBLOCK_SECTION_ID',
                    'TIMESTAMP_X',
                    'SORT',
                    'NAME',
                    'ACTIVE',
                    'GLOBAL_ACTIVE',
                    'LEFT_MARGIN',
                    'RIGHT_MARGIN',
                    'DEPTH_LEVEL',
                    'SEARCHABLE_CONTENT',
                    'MODIFIED_BY',
                    'DATE_CREATE',
                    'CREATED_BY',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "ID": "169",
                    "CODE": "marketing_documents",
                    "XML_ID": "ext_marketing_docs_002",
                    "EXTERNAL_ID": "ext_marketing_docs_002",
                    "IBLOCK_SECTION_ID": null,
                    "TIMESTAMP_X": "10/27/2025 12:00:30 pm",
                    "SORT": "600",
                    "NAME": "Updated Marketing Documents",
                    "ACTIVE": "Y",
                    "GLOBAL_ACTIVE": "Y",
                    "LEFT_MARGIN": "17",
                    "RIGHT_MARGIN": "18",
                    "DEPTH_LEVEL": "1",
                    "SEARCHABLE_CONTENT": "UPDATED MARKETING DOCUMENTS\r\n",
                    "MODIFIED_BY": "1269",
                    "DATE_CREATE": "10/27/2025 11:36:56 am",
                    "CREATED_BY": "1269"
                }
            ],
            "total": 1,
            "time": {
                "start": 1761556287,
                "finish": 1761556287.844517,
                "duration": 0.8445169925689697,
                "processing": 0,
                "date_start": "2025-10-27T12:11:27+02:00",
                "date_finish": "2025-10-27T12:11:27+02:00",
                "operating_reset_at": 1761556887,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
array

Data of the section or an array of sections. The result depends on the SELECT parameter.

An empty array means that there are no sections in the list, or the sections do not match the filter.

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 not provided.

ACCESS_DENIED

Access denied

Insufficient rights to read the section.

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