Get the List of Page Blocks `landing.block.getlist`

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: landing

Who can execute the method: a user with "view" access permission for sites

The method landing.block.getlist returns a list of blocks for the selected page.

Method Parameters

Required parameters are marked with *

Name `type`	Description
scope `string`	Internal scope for landings. It is not related to the REST scope `landing` in the method name. The value of `scope` must correspond to the type of site (detailed description)
lid* `integer` \| `integer[]`	Identifier of the page or an array of page identifiers. Page identifiers can be obtained using the method landing.landing.getList If `lid` is passed as an array, the method combines blocks from all specified pages into a single list. Each element in the response contains a `lid` field, which indicates the source page. If an array is passed and at least one page is not found or is unavailable, the entire call results in an error.
params `object`	Additional parameters for reading the list (detailed description)

Parameter params

Name `type`	Description
edit_mode `boolean` \| `integer`	If the value is cast to `true`, the method reads the draft version of the page instead of the published version. By default — `false`. Without this parameter, the method reads only published blocks.
deleted `boolean` \| `integer`	If the value is cast to `true`, the method returns only blocks marked as deleted. By default — `false`. This parameter only affects the selection of blocks. It does not include the search for deleted pages, so for a page in the trash, the method will return an error. To retrieve deleted blocks, pass `deleted: true` along with `edit_mode: true`. The `deleted` parameter alone does not switch the method to draft mode. If `edit_mode` is not specified, the method will search for blocks only in the published version of the page.
get_content `boolean` \| `integer`	If `true` is passed, the method will add the `content`, `css`, and `js` fields to each result element. By default — `false`. The `content` field contains the prepared HTML of the block along with the system container of the block, not the original saved content. If `edit_mode` is off, the method will return the HTML of the published version of the block. If `edit_mode` is on, the method will return the HTML of the draft.

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" \
          -d '{
            "lid": 4858,
            "params": {
              "edit_mode": true,
              "get_content": true
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getlist.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 4858,
            "params": {
              "edit_mode": true,
              "get_content": true
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.block.getlist.json"

try
        {
        	const response = await $b24.callMethod(
        		'landing.block.getlist',
        		{
        			lid: 4858,
        			params: {
        				edit_mode: true,
        				get_content: true
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.block.getlist',
                    [
                        'lid' => 4858,
                        'params' => [
                            'edit_mode' => true,
                            'get_content' => true,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting block list: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.block.getlist',
            {
                lid: 4858,
                params: {
                    edit_mode: true,
                    get_content: true
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.block.getlist',
            [
                'lid' => 4858,
                'params' => [
                    'edit_mode' => true,
                    'get_content' => true,
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "id": 28181,
                    "lid": 2215,
                    "code": "0.menu_02",
                    "name": "Menu with logo on the left and menu items on the right",
                    "active": true,
                    "meta": {
                        "LID": "2215",
                        "FAVORITE_META": "Array",
                        "CREATED_BY_ID": "779",
                        "DATE_CREATE": "09/13/2024 10:28:08 am",
                        "MODIFIED_BY_ID": "1295",
                        "DATE_MODIFY": "03/26/2026 12:21:48 pm",
                        "SITE_TYPE": "PAGE",
                        "LANDING_TITLE": "",
                        "LANDING_TPL_CODE": "bitrix.krayt_otdykh_na_prirode",
                        "SITE_TPL_CODE": "empty",
                        "XML_ID": "",
                        "DESIGNER_MODE": ""
                    },
                    "content": "<div id=\"b2884\" class=\"block-wrapper block-0-menu-02\"><header class=\"landing-block u-header u-header--float u-header--sticky\">...</header></div>",
                    "css": [],
                    "js": []
                }
            ],
            "time": {
                "start": 1774521039,
                "finish": 1774521039.570632,
                "duration": 0.5706319808959961,
                "processing": 0,
                "date_start": "2026-03-26T13:30:39+02:00",
                "date_finish": "2026-03-26T13:30:39+02:00",
                "operating_reset_at": 1774521639,
                "operating": 0.48987889289855957
            }
        }

Returned Data

Name
type

Description

result
object[]

List of blocks (detailed description).

The method can return result: [] without an error in three cases.

There are no blocks on the page for the selected reading mode.
The page has not yet been published and params.edit_mode is not enabled.
The deleted filter did not find any suitable blocks.

time
time

Information about the execution time of the request.

Block Object

Name `type`	Description
id `integer`	Identifier of the block.
lid `integer`	Identifier of the page to which the block belongs.
code `string`	Symbolic code of the block from the library, for example `0.menu_02`.
name `string`	Name of the block from its manifest.
active `boolean`	Indicator of the block's activity. An active block is displayed on the page. An inactive block is hidden.
meta `object`	Service data of the block and page (detailed description). All values within `meta` are returned as strings. The format of string dates depends on the language settings of Bitrix24.
content `string`	Prepared HTML of the block. This field is returned only if `params.get_content` is enabled. If `params.edit_mode = false`, the method will return the HTML of the published version of the block. If `params.edit_mode = true`, the method will return the HTML of the draft.
css `string[]`	Paths to the CSS files of the block needed for its display. This field is returned only if `params.get_content` is enabled. If there are no separate CSS resources, an empty array will be returned.
js `string[]`	Paths to the JS files of the block needed for its operation. This field is returned only if `params.get_content` is enabled. If there are no separate JS resources, an empty array will be returned.

Meta Object

Name `type`	Description
LID `string`	Identifier of the block's page in string format. Duplicates the top-level field `lid`.
CREATED_BY_ID `string`	Identifier of the user who created the block.
DATE_CREATE `string`	Date of block creation. The format depends on the language settings of the account.
MODIFIED_BY_ID `string`	Identifier of the user who last modified the block.
DATE_MODIFY `string`	Date of the last modification of the block. The format depends on the language settings of the account.
SITE_TYPE `string`	Type of the site to which the page belongs, such as `PAGE` or `STORE`.
LANDING_TITLE `string`	Title of the page to which the block belongs. If the title is not filled, an empty string will be returned.
LANDING_TPL_CODE `string`	Code of the page template.
SITE_TPL_CODE `string`	Code of the site template.
XML_ID `string`	External identifier of the block. If it is not specified, an empty string will be returned.

Error Handling

HTTP Status: 400

{
            "error": "LANDING_NOT_EXIST",
            "error_description": "Landing 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
`MISSING_PARAMS`	Required top-level parameter `lid` is not provided.
`LANDING_NOT_EXIST`	The page is not found, deleted, or unavailable to the current user.
`ACCESS_DENIED`	The user does not have permission to view sites.
`TYPE_ERROR`	Internal type mismatch error when calling the method.
`SYSTEM_ERROR`	Internal error during method execution.

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

Upload and Attach Image to Block

Get Block by ID

Get the List of Page Blocks landing.block.getlist

Method ParametersMethod Parameters

Parameter paramsParameter params

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Block ObjectBlock Object

Meta ObjectMeta Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning