Get Block by ID landing.block.getbyid

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 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 -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"
        
// 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 BlockByIdResult = {
          id: number
          lid: number
          code: string
          name: string
          active: boolean
          meta: {
            LID: string
            FAVORITE_META: string
            CREATED_BY_ID: string
            DATE_CREATE: string
            MODIFIED_BY_ID: string
            DATE_MODIFY: string
            SITE_TYPE: string
            LANDING_TITLE: string
            LANDING_TPL_CODE: string
            SITE_TPL_CODE: string
            XML_ID: string
            DESIGNER_MODE: string
          }
          content?: string
          css?: string[]
          js?: string[]
        }
        
        try {
          const response = await $b24.actions.v2.call.make<BlockByIdResult>({
            method: 'landing.block.getbyid',
            params: {
              block: 39556,
              params: {
                edit_mode: true,
                get_content: true,
              },
            },
            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.name, result.active, result.content)
          }
        } 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 getBlockById() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.block.getbyid',
                params: {
                  block: 39556,
                  params: {
                    edit_mode: true,
                    get_content: true,
                  },
                },
                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.name, result.active, result.content)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getBlockById)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.block.getbyid(
                block=39556,
                params={
                    "edit_mode": True,
                    "get_content": True,
                },
            ).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.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>';
        }
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "landing.block.getbyid", b24.Params{
        	"block": 39556,
        	"params": b24.Params{
        		"edit_mode":   true,
        		"get_content": true,
        	},
        })
        if err != nil {
        	return fmt.Errorf("landing.block.getbyid: %w", err)
        }
        
        var item struct {
        	ID      b24.ID `json:"id"`
        	Lid     int    `json:"lid"`
        	Code    string `json:"code"`
        	Name    string `json:"name"`
        	Active  bool   `json:"active"`
        	Content string `json:"content"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Lid)
        

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

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