Get the Manifest File of the Block landing.block.getmanifestfile

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 access to the "Sites and Stores" section

The method landing.block.getmanifestfile returns the original manifest of the block from the file repository.

Unlike landing.block.getmanifest, this method returns the manifest in its original form — as specified in the .description.php file. It does not add any service fields, such as code, preview, or timestamp.

Method Parameters

Required parameters are marked with *

Name
type

Description

code*
string

The code of the block from the file repository.

You can provide a short code, such as 01.big_with_text. In this case, the method will search for the block only in the bitrix namespace and will automatically add the prefix bitrix:.

If you need a block from a different namespace, provide the full code in the format <namespace>:<code>.

The code can only contain Latin letters, numbers, and the characters . _ - :

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "code": "01.big_with_text"
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.block.getmanifestfile.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "code": "01.big_with_text",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.block.getmanifestfile.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 ManifestFileResult = {
          block?: Record<string, unknown>
          cards?: Record<string, unknown>
          nodes?: Record<string, unknown>
          style?: Record<string, unknown>
          attrs?: Record<string, unknown>
          assets?: Record<string, unknown>
          menu?: Record<string, unknown>
        }
        
        try {
          const response = await $b24.actions.v2.call.make<ManifestFileResult>({
            method: 'landing.block.getmanifestfile',
            params: {
              code: '01.big_with_text',
            },
            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.block, result.nodes)
          }
        } 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 getManifestFile() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.block.getmanifestfile',
                params: {
                  code: '01.big_with_text',
                },
                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.block, result.nodes)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getManifestFile)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.landing.block.getmanifestfile(
                code="01.big_with_text",
            ).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.getmanifestfile',
                    [
                        'code' => '01.big_with_text',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting block manifest file: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.block.getmanifestfile',
            {
                code: '01.big_with_text'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.block.getmanifestfile',
            [
                'code' => '01.big_with_text',
            ]
        );
        
        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.getmanifestfile", b24.Params{
        	"code": "01.big_with_text",
        })
        if err != nil {
        	return fmt.Errorf("landing.block.getmanifestfile: %w", err)
        }
        
        keys, ok := b24.Keys(res.Result)
        if !ok {
        	return fmt.Errorf("expected an object in the response")
        }
        fmt.Println("fields in response:", len(keys))
        

Response Handling

HTTP Status: 200

{
            "result": {
                "block": {
                    "name": "Cover with Changing Background Images",
                    "section": [
                        "cover"
                    ],
                    "dynamic": false
                },
                "cards": {
                    ".landing-block-card-img": {
                        "name": "Background Image",
                        "label": [
                            ".landing-block-card-img"
                        ]
                    }
                },
                "nodes": {
                    ".landing-block-node-small-title": {
                        "name": "Subtitle",
                        "type": "text"
                    },
                    ".landing-block-node-title": {
                        "name": "Title",
                        "type": "text"
                    },
                    ".landing-block-node-text": {
                        "name": "Text",
                        "type": "text"
                    },
                    ".landing-block-node-button": {
                        "name": "Button",
                        "type": "link"
                    },
                    ".landing-block-card-img": {
                        "name": "Background Image",
                        "type": "img",
                        "dimensions": {
                            "width": 1920,
                            "height": 1080
                        },
                        "allowInlineEdit": false,
                        "useInDesigner": false,
                        "create2xByDefault": false
                    }
                },
                "style": {
                    "block": {
                        "type": [
                            "display"
                        ],
                        "additional": {
                            "name": "Slider",
                            "attrsType": [
                                "autoplay",
                                "autoplay-speed",
                                "pause-hover",
                                "dots"
                            ]
                        }
                    },
                    "nodes": {
                        ".landing-block-node-text-container": {
                            "title": "Set of Elements",
                            "type": [
                                "background-color",
                                "animation"
                            ]
                        },
                        ".landing-block-node-small-title": {
                            "title": "Subtitle",
                            "type": [
                                "typo",
                                "heading"
                            ]
                        },
                        ".landing-block-node-title": {
                            "title": "Title",
                            "type": [
                                "typo",
                                "heading"
                            ]
                        },
                        ".landing-block-node-text": {
                            "title": "Text",
                            "type": "typo"
                        },
                        ".landing-block-node-button": {
                            "title": "Button",
                            "type": "button"
                        },
                        ".landing-block-card-img": {
                            "name": "Background Image",
                            "type": [
                                "background-overlay",
                                "height-vh"
                            ]
                        }
                    }
                },
                "assets": {
                    "ext": [
                        "landing_carousel"
                    ]
                }
            },
            "time": {
                "start": 1774521452,
                "finish": 1774521452.955493,
                "duration": 0.9554929733276367,
                "processing": 0,
                "date_start": "2026-03-26T13:37:32+02:00",
                "date_finish": "2026-03-26T13:37:32+02:00",
                "operating_reset_at": 1774522052,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object | array

The original manifest of the block from the file repository.

The general format of the manifest file is described in the article Manifest File.

If the block is not found, the code contains invalid characters, or a local repository block code of the form repo_<ID> is provided, the method will return an empty array [] without an error

time
time

Information about the execution time of the request

Object result

Name
type

Description

block
object

Description of the block from the block section of the manifest file. Usually contains fields: name, section, dynamic, type, system, description, version, id, only_for_license

cards
object | array

Description of the block cards, if any

nodes
object | array

Description of the editable nodes of the block

style
object | array

Description of the available style settings of the block as declared in the manifest

attrs
object | array

Description of the customizable attributes of the block, if specified

assets
object

Resources explicitly declared in the block manifest.

For example, the response may include assets.ext if extensions are declared directly in .description.php

menu
object | array

Description of the block menu, if any

The result may contain other keys. Their composition depends on the specific block and the contents of the manifest.

In nested objects, such as nodes, cards, and style.nodes, the set of fields also depends on the specific block. The method returns this data in its original form, so one block may use the field title, while another uses name.

Localizable names and labels are returned in the portal's language if they are specified in the manifest through language files.

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Not enough call parameters, missing: code"
        }
        

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

The required parameter code is missing

ACCESS_DENIED

Access denied: the user does not have access to the "Sites and Stores" section

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