Get the List of Page Blocks landing.block.getlist
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:
landingWho 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 |
Description |
|
scope |
Internal scope for landings. It is not related to the REST scope The value of |
|
Identifier of the page or an array of page identifiers. Page identifiers can be obtained using the method landing.landing.getList If If an array is passed and at least one page is not found or is unavailable, the entire call results in an error. |
|
|
params |
Additional parameters for reading the list (detailed description) |
Parameter params
|
Name |
Description |
|
If the value is cast to By default — |
|
|
If the value is cast to By default — To retrieve deleted blocks, pass If |
|
|
If The If |
Code Examples
How to Use Examples in Documentation
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"
// 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 each LandingBlock returned in result[]
type LandingBlock = {
id: number
lid: number
code: string
name: string
active: boolean
meta: Record<string, string>
content?: string
css?: string[]
js?: string[]
}
try {
// landing.block.getlist returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<LandingBlock[]>({
method: 'landing.block.getlist',
params: {
lid: 4858,
params: {
edit_mode: true,
get_content: true,
},
start: 0,
},
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('Blocks on page:', result.length, result)
}
} 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 getBlockList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// landing.block.getlist returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'landing.block.getlist',
params: {
lid: 4858,
params: {
edit_mode: true,
get_content: true,
},
start: 0,
},
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('Blocks on page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getBlockList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.block.getlist(
lid=4858,
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.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>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.block.getlist", b24.Params{
"lid": 4858,
"params": b24.Params{
"edit_mode": true,
"get_content": true,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("landing.block.getlist: %w", err)
}
var items []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, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Lid)
}
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 |
Description |
|
result |
List of blocks (detailed description). The method can return
|
|
time |
Information about the execution time of the request. |
Block Object
|
Name |
Description |
|
id |
Identifier of the block. |
|
lid |
Identifier of the page to which the block belongs. |
|
code |
Symbolic code of the block from the library, for example |
|
name |
Name of the block from its manifest. |
|
active |
Indicator of the block's activity. An active block is displayed on the page. An inactive block is hidden. |
|
meta |
Service data of the block and page (detailed description). All values within |
|
content |
Prepared HTML of the block. This field is returned only if If |
|
css |
Paths to the CSS files of the block needed for its display. This field is returned only if |
|
js |
Paths to the JS files of the block needed for its operation. This field is returned only if |
Meta Object
|
Name |
Description |
|
LID |
Identifier of the block's page in string format. Duplicates the top-level field |
|
CREATED_BY_ID |
Identifier of the user who created the block. |
|
DATE_CREATE |
Date of block creation. The format depends on the language settings of the account. |
|
MODIFIED_BY_ID |
Identifier of the user who last modified the block. |
|
DATE_MODIFY |
Date of the last modification of the block. The format depends on the language settings of the account. |
|
SITE_TYPE |
Type of the site to which the page belongs, such as |
|
LANDING_TITLE |
Title of the page to which the block belongs. If the title is not filled, an empty string will be returned. |
|
LANDING_TPL_CODE |
Code of the page template. |
|
SITE_TPL_CODE |
Code of the site template. |
|
XML_ID |
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Required top-level parameter |
|
|
The page is not found, deleted, or unavailable to the current user. |
|
|
The user does not have permission to view sites. |
|
|
Internal type mismatch error when calling the method. |
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |