Get Content of Block landing.block.getcontent

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: landing

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

The method landing.block.getcontent returns the ready HTML of the block, its resources, manifest, and service properties of the block.

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)

lid*
integer

Page identifier.

The page identifier can be obtained using the method landing.landing.getlist

block*
integer

Block identifier.

The block identifier can be obtained using the method landing.block.getlist

editMode
boolean

Mode for obtaining the version of the block.

Possible values:
true — return the draft of the block from the page,
false — return the published version of the block.

Default is false. When editMode=true, the method automatically includes the return of HTML for inactive blocks.

If the page has not yet been published, a call without editMode may not find the block

params
object

Additional parameters (detailed description)

Parameter params

Name
type

Description

wrapper_show
boolean

Whether to return the external container of the block <div class="block-wrapper"> in result.content.

Possible values:
true — return HTML along with the external container of the block used by the Bitrix24 page editor,
false — return the HTML of the block without the container. Default is true

force_unactive
boolean

Generate HTML even for inactive blocks.

Possible values:
true — return HTML of the inactive block,
false — if the block is inactive, the result.content field will return an empty string.

Default is false. When editMode=true, this mode is automatically enabled

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 4858,
            "block": 39556,
            "editMode": true,
            "params": {
              "wrapper_show": false
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getcontent.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "lid": 4858,
            "block": 39556,
            "editMode": true,
            "params": {
              "wrapper_show": false
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.block.getcontent.json"
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type BlockContentResult = {
          id: number
          sections: string
          active: boolean
          access: string
          anchor: string
          php: boolean
          designed: boolean
          repoId: number | null
          content: string
          content_ext: string
          css: string[]
          js: string[]
          assetStrings: string[]
          lang: string[] | Record<string, string>
          manifest: Record<string, unknown>
          dynamicParams: unknown[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<BlockContentResult>({
            method: 'landing.block.getcontent',
            params: {
              lid: 4858,
              block: 39556,
              editMode: true,
              params: {
                wrapper_show: false,
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.id, result.content, result.active)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getBlockContent() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.block.getcontent',
                params: {
                  lid: 4858,
                  block: 39556,
                  editMode: true,
                  params: {
                    wrapper_show: false,
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.id, result.content, result.active)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getBlockContent)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.block.getcontent(
                lid=4858,
                block=39556,
                edit_mode=True,
                params={
                    "wrapper_show": False,
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.block.getcontent',
                    [
                        'lid' => 4858,
                        'block' => 39556,
                        'editMode' => true,
                        'params' => [
                            'wrapper_show' => false,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting block content: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.block.getcontent',
            {
                lid: 4858,
                block: 39556,
                editMode: true,
                params: {
                    wrapper_show: false
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.block.getcontent',
            [
                'lid' => 4858,
                'block' => 39556,
                'editMode' => true,
                'params' => [
                    'wrapper_show' => false,
                ],
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "landing.block.getcontent", b24.Params{
        	"lid":      4858,
        	"block":    39556,
        	"editMode": true,
        	"params": b24.Params{
        		"wrapper_show": false,
        	},
        })
        if err != nil {
        	return fmt.Errorf("landing.block.getcontent: %w", err)
        }
        
        var item struct {
        	ID       b24.ID `json:"id"`
        	Sections string `json:"sections"`
        	Active   bool   `json:"active"`
        	Access   string `json:"access"`
        	Anchor   string `json:"anchor"`
        	Php      bool   `json:"php"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Sections)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "id": 28853,
                "sections": "tiles,news",
                "active": true,
                "access": "X",
                "anchor": "b28853",
                "php": false,
                "designed": false,
                "repoId": null,
                "content": "<div id=\"block28853\" data-id=\"28853\" 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>",
                "content_ext": "",
                "css": [],
                "js": [
                    "/bitrix/js/pull/protobuf/protobuf.js?1592315491274055",
                    "/bitrix/js/pull/protobuf/model.min.js?159231549114190",
                    "/bitrix/js/main/core/core_promise.min.js?17647596972494",
                    "/bitrix/js/rest/client/rest.client.min.js?16015491189240",
                    "/bitrix/js/pull/client/pull.client.min.js?174471771449849"
                ],
                "assetStrings": [],
                "lang": [],
                "manifest": {
                    "block": {
                        "name": "List of Pages with Small Image on the Left",
                        "section": [
                            "tiles",
                            "news"
                        ]
                    },
                    "cards": {
                        ".landing-block-card": {
                            "name": "Card",
                            "label": [
                                ".landing-block-node-img",
                                ".landing-block-node-title"
                            ]
                        }
                    }
                },
                "dynamicParams": []
            },
            "time": {
                "start": 1774520845,
                "finish": 1774520845.380018,
                "duration": 0.3800179958343506,
                "processing": 0,
                "date_start": "2026-03-26T13:27:25+01:00",
                "date_finish": "2026-03-26T13:27:25+01:00",
                "operating_reset_at": 1774521445,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Block data (detailed description)

time
time

Information about the execution time of the request

Object result

Name
type

Description

id
integer

Block identifier

sections
string

Codes of the block sections from the manifest, concatenated into a string

active
boolean

Indicator of the block's activity

access
string

Access level to the block. Possible values:

A — access is closed to all blocks,
D — access is denied,
V — can edit only the design,
W — can edit content and design without deletion,
X — full access.

anchor
string

Local anchor of the block.

The value is used as the HTML attribute id for the external wrapper of the block and in links to the block within the page

php
boolean

Indicator that there is PHP code in the original content of the block

designed
boolean

Indicator that the block has been modified in the designer

repoId
integer

Identifier of the REST block from the repository or null if the block is not linked to a REST repository

content
string

Ready HTML of the block for output on the page.

Returns the final HTML after rendering, not the block template.

If params.wrapper_show=true, the field returns HTML along with the external container of the block. If params.wrapper_show=false, it returns only the HTML of the block.

If the block is inactive and params.force_unactive=false, the field returns an empty string

content_ext
string

Additional HTML code of connected extensions

css
array

List of CSS resources of the block and dependencies connected during rendering.

If there are no separate CSS connections, an empty array is returned

js
array

List of JS resources of the block and dependencies connected during rendering.

If editMode=true is requested for a REST block with repoId not equal to null, the block's own JS resources are not returned

assetStrings
array

Initialization strings of resources to be added to the page

lang
array | object

Language messages of connected extensions in the format of key: value object.

If connected extensions have no language messages, an empty array is returned

manifest
object

The complete manifest of the block. The general format is described in the article Block Manifest

dynamicParams
array

Data source parameters for the dynamic block.

For a static block, the field returns an empty array

requiredUserAction
array

Additional action that needs to be performed after loading the block.

The field is returned only in editMode, if an additional action is required from the user after loading the block

Error Handling

HTTP Status: 400

{
            "error": "BLOCK_NOT_FOUND",
            "error_description": "Block not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

MISSING_PARAMS

Required top-level parameter lid or block is missing

LANDING_NOT_EXIST

Page with identifier lid not found or not accessible to the current user

ACCESS_DENIED

No access to the "Sites and Stores" section

BLOCK_NOT_FOUND

Block with identifier block not found in the selected version of the page

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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