Get Block by ID `landing.block.getbyid`

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.getbyid returns a single block of a page by its identifier.

Method Parameters

Required parameters are marked with *

Name `type`	Description
scope `string`	Internal scope of 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)
block* `integer`	Block identifier. The block identifier can be obtained using the method landing.block.getlist
params `object`	Additional parameters for reading the block (detailed description)

Parameter params

Name `type`	Description
edit_mode `boolean` \| `integer`	If set to `true`, the method reads the draft version of the page instead of the published version. Default is `false`
deleted `boolean` \| `integer`	If set to `true`, the method searches for blocks marked as deleted. Default is `false`. To retrieve a deleted block, you must pass `deleted: true` along with `edit_mode: true`
get_content `boolean` \| `integer`	If set to `true`, the `result` additionally returns the fields `content`, `css`, and `js`. Default is `false`. The `content` field contains the prepared HTML of the block along with the system container of the block, not the original saved content

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

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

try
        {
        	const response = await $b24.callMethod(
        		'landing.block.getbyid',
        		{
        			block: 39556,
        			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.getbyid',
                    [
                        'block' => 39556,
                        '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 by ID: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.block.getbyid',
            {
                block: 39556,
                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.getbyid',
            [
                'block' => 39556,
                '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": 39556,
                "lid": 4858,
                "code": "01.big_with_text",
                "name": "Block with Text and Image",
                "active": true,
                "meta": {
                    "LID": "2215",
                    "FAVORITE_META": "Array",
                    "CREATED_BY_ID": "1295",
                    "DATE_CREATE": "03/26/2026 11:27:24 am",
                    "MODIFIED_BY_ID": "1295",
                    "DATE_MODIFY": "03/26/2026 12:23:02 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=\"b28853\" class=\"block-wrapper block-18-2-two-cols-fix-img-text-button-with-cards\"><section class=\"landing-block g-pt-30 g-pb-30 g-bg-transparent\">...</section></div>",
                "css": [],
                "js": []
            },
            "time": {
                "start": 1774521156,
                "finish": 1774521157.330784,
                "duration": 1.3307840824127197,
                "processing": 1,
                "date_start": "2026-03-26T13:32:36+01:00",
                "date_finish": "2026-03-26T13:32:37+01:00",
                "operating_reset_at": 1774521756,
                "operating": 0.3684520721435547
            }
        }

Returned Data

Name
type

Description

result
object

Data of the found block (detailed description)

The method does not return result: []. If the block is not found in the selected version of the page, the method ends with an error

time
time

Information about the execution time of the request

Object result

Name `type`	Description
id `integer`	Block identifier
lid `integer`	Identifier of the page to which the block belongs
code `string`	Symbolic code of the block from the library, for example `01.big_with_text`
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. A non-active block is hidden
meta `object`	Service data of the block and page (detailed description). All values inside `meta` are returned as strings. The format of string dates depends on the language settings of Bitrix24
content `string`	Prepared HTML of the block. The field is returned only if `params.get_content` is enabled
css `string[]`	Paths to the CSS files of the block needed for its display. The 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. The field is returned only if `params.get_content` is enabled. If there are no separate JS resources, an empty array will be returned

Object meta

Name `type`	Description
LID `string`	Identifier of the block's page in string format. Duplicates the `lid` field
CREATED_BY_ID `string`	Identifier of the user who created the block
DATE_CREATE `string`	Date of block creation
MODIFIED_BY_ID `string`	Identifier of the user who last modified the block
DATE_MODIFY `string`	Date of the last modification of the block
SITE_TYPE `string`	Type of the site to which the page belongs, for example `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 set, an empty string will be returned
DESIGNER_MODE `string`	Service field of the designer mode. In the method `landing.block.getbyid`, it is returned as an empty string
FAVORITE_META `string`	Service data about saving the block in the user's favorite templates. If such data is not available, an empty string will be returned. If data is available, in this method the value may come as the string `"Array"`

Error Handling

HTTP Status: 400

{
            "error": "BLOCK_NOT_FOUND",
            "error_description": "Block 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`	Insufficient call parameters, missing: `block`
`ACCESS_DENIED`	User does not have access to the "Sites and Stores" section
`BLOCK_NOT_FOUND`	Block not found in the selected version of the page, unavailable to the current user, or deleted
`TYPE_ERROR`	Internal type mismatch error during method call
`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

Get List of Page Blocks

Get Block Manifest

Get Block by ID landing.block.getbyid

Method ParametersMethod Parameters

Parameter paramsParameter params

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object metaObject meta

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning