Get a List of Templates for Creating Pages landing.demos.getPageList
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
landingWho can execute the method: a user with View access permission in the Sites section
The method landing.demos.getPageList retrieves a list of file demo templates for pages.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
type* |
Template type. Possible values:
|
|
filter |
Object format:
where:
Filtering is applied to the top-level fields of the template object. You can filter by fields from the Page Template Type section. Nested fields (e.g., |
Code Examples
How to Use Examples in Documentation
Example of retrieving a list of page templates, where:
type— code of the template setfilter— filter by template fields
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"type": "page",
"filter": {
"TYPE": "PAGE"
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.demos.getPageList.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"type": "page",
"filter": {
"TYPE": "PAGE"
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.demos.getPageList.json"
try
{
const response = await $b24.callMethod(
'landing.demos.getPageList',
{
type: 'page',
filter: {
TYPE: 'PAGE'
}
}
);
console.info(response.getData().result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.demos.getPageList',
[
'type' => 'page',
'filter' => [
'TYPE' => 'PAGE',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting page demo list: ' . $e->getMessage();
}
BX24.callMethod(
'landing.demos.getPageList',
{
type: 'page',
filter: {
TYPE: 'PAGE'
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.demos.getPageList',
[
'type' => 'page',
'filter' => [
'TYPE' => 'PAGE',
],
]
);
echo '<pre>';
print_r($result);
echo '</pre>';
Response Handling
HTTP Status: 200
{
"result": {
"empty": {
"ID": "empty",
"XML_ID": "empty",
"TYPE": ["PAGE", "KNOWLEDGE", "GROUP", "MAINPAGE"],
"TITLE": "Empty Page",
"ACTIVE": true,
"PUBLICATION": false,
"LOCK_DELETE": false,
"AVAILABLE": true,
"SINGLETON": false,
"SECTION": [],
"DESCRIPTION": "Create your own website from scratch and attract customers!",
"PREVIEW": "//bitrix24.com/bitrix/components/bitrix/landing.demo/data/page/empty/preview.jpg",
"PREVIEW2X": "//bitrix24.com/bitrix/components/bitrix/landing.demo/data/page/empty/preview@2x.jpg",
"PREVIEW3X": "//bitrix24.com/bitrix/components/bitrix/landing.demo/data/page/empty/preview@3x.jpg",
"APP_CODE": "",
"REST": 0,
"DATA": {
"name": "Empty Page",
"active": true,
"type": ["PAGE", "KNOWLEDGE", "GROUP", "MAINPAGE"],
"items": [],
"version": 1,
"old_id": 402,
"encoded": true,
"charset": "UTF-8"
}
},
"search-result": {
"ID": "search-result",
"XML_ID": "search-result",
"TYPE": ["PAGE", "KNOWLEDGE", "GROUP"],
"TITLE": "Search Results",
"ACTIVE": false,
"PUBLICATION": true,
"SECTION": ["dynamic"],
"DATA": {
"code": "search-result",
"section": ["dynamic"],
"publication": true,
"layout": [],
"items": {
"#block3430": {
"code": "59.1.search"
}
},
"encoded": true,
"charset": "UTF-8"
}
}
},
"time": {
"start": 1774625365,
"finish": 1774625365.92986,
"duration": 0.9298601150512695,
"processing": 0,
"date_start": "2026-03-27T18:29:25+02:00",
"date_finish": "2026-03-27T18:29:25+02:00",
"operating_reset_at": 1774625965,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
Map of page demo templates in the format:
where:
If no suitable templates are found, the method returns an empty array The composition of template fields may vary and depends on the specific template |
|
|
time |
Information about the execution time of the request |
Page Template Type
|
Name |
Description |
|
ID |
Template identifier |
|
XML_ID |
External template code |
|
Types for which the template is available. For file templates, an array is usually returned; for registered application templates — a string |
|
|
TITLE |
Template title |
|
ACTIVE |
Active status |
|
PUBLICATION |
Publication availability status |
|
LOCK_DELETE |
Deletion prohibition status |
|
AVAILABLE |
Template availability status |
|
SINGLETON |
Singleton status |
|
SECTION |
Template sections |
|
DESCRIPTION |
Template description |
|
PREVIEW |
Preview 1x |
|
PREVIEW2X |
Preview 2x |
|
PREVIEW3X |
Preview 3x |
|
APP_CODE |
Application code |
|
REST |
REST template status |
|
Template data from file source more details. For registered application templates, an empty array may be returned |
Template DATA Structure
|
Name |
Description |
|
code |
Template code in export data |
|
name |
Template name in export data |
|
type |
Template types. Possible values:
|
|
Template description |
|
|
active |
Template active status in export data |
|
publication |
Template publication status in export data |
|
singleton |
Template singleton status in export data |
|
lock_delete |
Deletion prohibition status in export data |
|
preview |
Preview 1x in export data |
|
preview2x |
Preview 2x in export data |
|
preview3x |
Preview 3x in export data |
|
preview_url |
Preview link in export data |
|
show_in_list |
Show in list status ( |
|
sort |
Template sorting index |
|
section |
Template sections in export data |
|
parent |
Parent template/site code |
|
disable_import |
Import prohibition flag in template data (e.g., |
|
is_webform_page |
CRM form page flag (e.g., |
|
fields |
Template fields more details. Codes for |
|
Template composition more details |
|
|
Template layout data more details |
|
|
Template folders more details |
|
|
Template system pages more details |
|
|
master_pages |
List of template master pages more details |
|
version |
Data format version |
|
Original identifier (may come as a number or string depending on the template) |
|
|
encoded |
Added by the method with a value of |
|
charset |
Added by the method with a value of |
Error Handling
HTTP Status: 400
{
"error": "ERROR_ARGUMENT",
"error_description": "The value of an argument 'filter' has an invalid type",
"argument": "filter"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
The value of an argument 'filter' has an invalid type |
The |
|
|
Insufficient call parameters |
The required parameter |
|
|
Insufficient permissions |
The user did not pass the general access checks for the Landing module |
|
|
Data type error |
Method call with incorrect parameter types |
|
|
Internal error |
Error executing the method on the server side |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Register a Template in the Site Creation Wizard landing.demos.register
- Get a List of Templates for Creating Websites landing.demos.getSiteList
- Get a List of Registered Templates landing.demos.getList
- Delete Registered Template landing.demos.unregister
- Template Localization
- Custom Templates: Overview of Methods