Get a List of Custom Blocks landing.repo.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 in the Sites and Stores section
The method landing.repo.getList retrieves a list of custom blocks.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
params |
Object format:
where:
For more details on each parameter, see the params parameter section |
params Parameter
|
Name |
Description |
|
select |
Array format:
where:
For a list of available fields for selection, see the result element type section. Elements in |
|
filter |
Object format:
where:
For a list of available fields for filtering, see the result element type section. If |
|
order |
Object format:
where:
For a list of available fields for sorting, see the result element type section |
|
group |
Array of fields for grouping the result. Format:
where:
Examples:
For a list of available fields, see the result element type section |
|
limit |
Limit of records |
|
offset |
Offset of records |
Note
If the method is called in the context of an application, the server additionally adds a filter for the current application.
In this case, only blocks created by the same application will be included in the response.
Code Examples
How to Use Examples in Documentation
Example of retrieving a list of blocks, where:
params.select— fields to return in the responseparams.filter— conditions for filtering recordsparams.order— sorting the resultparams.group— grouping fields
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": ["ID", "NAME", "DATE_MODIFY"],
"filter": {"ACTIVE": "Y"},
"order": {"ID": "DESC"},
"group": ["ACTIVE"]
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.repo.getList.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": ["ID", "NAME", "DATE_MODIFY"],
"filter": {"ACTIVE": "Y"},
"order": {"ID": "DESC"},
"group": ["ACTIVE"]
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.repo.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 RepoBlockItem returned in result[]
type RepoBlockItem = {
ID: string
XML_ID: string
APP_CODE: string | null
ACTIVE: string
NAME: string
DESCRIPTION: string
SECTIONS: string
SITE_TEMPLATE_ID: string | null
PREVIEW: string
MANIFEST: object | boolean
CONTENT: string
CREATED_BY_ID: string
MODIFIED_BY_ID: string
DATE_CREATE: string
DATE_MODIFY: string
}
try {
// landing.repo.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<RepoBlockItem[]>({
method: 'landing.repo.getList',
params: {
params: {
select: ['ID', 'NAME', 'DATE_MODIFY'],
filter: { ACTIVE: 'Y' },
order: { ID: 'DESC' },
group: ['ACTIVE'],
},
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 fetched:', 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 getRepoBlockList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// landing.repo.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.repo.getList',
params: {
params: {
select: ['ID', 'NAME', 'DATE_MODIFY'],
filter: { ACTIVE: 'Y' },
order: { ID: 'DESC' },
group: ['ACTIVE'],
},
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 fetched:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getRepoBlockList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.repo.get_list(
params={
"select": [
"ID",
"NAME",
"DATE_MODIFY",
],
"filter": {
"ACTIVE": "Y",
},
"order": {
"ID": "DESC",
},
"group": [
"ACTIVE",
],
},
).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.repo.getList',
[
'params' => [
'select' => ['ID', 'NAME', 'DATE_MODIFY'],
'filter' => ['ACTIVE' => 'Y'],
'order' => ['ID' => 'DESC'],
'group' => ['ACTIVE'],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting landing repository list: ' . $e->getMessage();
}
BX24.callMethod(
'landing.repo.getList',
{
params: {
select: ['ID', 'NAME', 'DATE_MODIFY'],
filter: { ACTIVE: 'Y' },
order: { ID: 'DESC' },
group: ['ACTIVE']
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.repo.getList',
[
'params' => [
'select' => ['ID', 'NAME', 'DATE_MODIFY'],
'filter' => ['ACTIVE' => 'Y'],
'order' => ['ID' => 'DESC'],
'group' => ['ACTIVE'],
],
]
);
echo '<pre>';
print_r($result);
echo '</pre>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.repo.getList", b24.Params{
"params": b24.Params{
"select": []string{"ID", "NAME", "DATE_MODIFY"},
"filter": b24.Params{
"ACTIVE": "Y",
},
"order": b24.Params{
"ID": "DESC",
},
"group": []string{"ACTIVE"},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("landing.repo.getList: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
XMLID string `json:"XML_ID"`
AppCode string `json:"APP_CODE"`
Active string `json:"ACTIVE"`
Name string `json:"NAME"`
Description string `json:"DESCRIPTION"`
}
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.XMLID)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"ID": "5",
"XML_ID": "ctx_full_1774873150158",
"APP_CODE": "bitrix.restapi",
"ACTIVE": "Y",
"NAME": "Context full test block",
"DESCRIPTION": "Check full fields from getList",
"SECTIONS": "cover,about",
"SITE_TEMPLATE_ID": null,
"PREVIEW": "https://www.bitrix24.com/images/b24_screen.png",
"MANIFEST": {
"block": {
"name": "Context full test block"
},
"nodes": {
".landing-block-node-text": {
"name": "Text",
"type": "text"
}
}
},
"CONTENT": "<section class=\"landing-block\"><div class=\"container\">Test</div></section>",
"CREATED_BY_ID": "577",
"MODIFIED_BY_ID": "577",
"DATE_CREATE": "30.03.2026 14:19:11",
"DATE_MODIFY": "30.03.2026 14:19:11"
}
],
"time": {
"start": 1774873153,
"finish": 1774873153.634216,
"duration": 0.6342160701751709,
"processing": 0,
"date_start": "2026-03-30T15:19:13+02:00",
"date_finish": "2026-03-30T15:19:13+02:00",
"operating_reset_at": 1774873753,
"operating": 0.11733078956604004
}
}
Returned Data
|
Name |
Description |
|
result |
List of blocks more details |
|
time |
Information about the request execution time |
Result Element Type
|
Name |
Description |
|
ID |
Identifier of the block |
|
XML_ID |
External code of the block |
|
Application code |
|
|
ACTIVE |
Activity status ( |
|
NAME |
Name of the block |
|
DESCRIPTION |
Description of the block |
|
SECTIONS |
Sections of the block |
|
Identifier of the site template |
|
|
PREVIEW |
Link to preview |
|
Manifest of the block. For more details on the manifest structure: Manifest format description. Example of a manifest in the method response: landing.block.getManifestFile |
|
|
CONTENT |
HTML of the block |
|
CREATED_BY_ID |
Identifier of the author |
|
MODIFIED_BY_ID |
Identifier of the user who modified the record |
|
DATE_CREATE |
Creation date in the format |
|
DATE_MODIFY |
Modification date in the format |
Error Handling
HTTP Status: 400
{
"error": "ERROR_ARGUMENT",
"error_description": "The value of an argument 'params' has an invalid type",
"argument": "params"
}
{
"error": "ACCESS_DENIED",
"error_description": "Insufficient permissions."
}
|
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 |
Value |
|
|
Insufficient permissions |
User did not pass general access checks |
|
|
The value of an argument 'params' has an invalid type |
The |
|
|
Internal error |
Error executing the method on the server side |
|
|
Insufficient scope for the token |
The token does not contain the |
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 |