landing.demos.getSiteList
Получить список шаблонов для создания сайтов
Описание
Метод landing.demos.getSiteList получает список файловых демо-шаблонов сайтов.
Параметры
type
string
необязательный
Тип шаблона.
Возможные значения:
- page — шаблоны для страниц
- store — шаблоны для магазинов
- knowledge — шаблоны для баз знаний
- group — шаблоны для групп
- mainpage — шаблоны для главных страниц
filter
object
необязательный
Объект формата:
{
field_1: value_1,
field_2: value_2,
...,
field_n: value_n
}
где:
- field_n — поле фильтра
- value_n — значение фильтра
Фильтрация применяется к полям верхнего уровня объекта шаблона.
Фильтровать можно по полям из раздела Тип шаблона сайта. Вложенные поля (например, DATA.*) в фильтре не учитываются
Примеры запроса
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.getSiteList.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.getSiteList.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 SiteListResult = Record<string, SiteTemplate>
type SiteTemplate = {
ID: string,
XML_ID: string,
TYPE: string[] | string,
TITLE: string,
ACTIVE: boolean,
PUBLICATION: boolean,
LOCK_DELETE: boolean,
AVAILABLE: boolean,
SINGLETON: boolean,
SECTION: string[],
DESCRIPTION: string,
PREVIEW: string,
PREVIEW2X: string,
PREVIEW3X: string,
APP_CODE: string,
REST: number,
DATA: Record<string, unknown>,
}
try {
const response = await $b24.actions.v2.call.make<SiteListResult>({
method: 'landing.demos.getSiteList',
params: {
type: 'page',
filter: {
TYPE: 'page',
},
},
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('Site demo templates:', Object.keys(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 fetchSiteList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.demos.getSiteList',
params: {
type: 'page',
filter: {
TYPE: 'page',
},
},
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('Site demo templates:', Object.keys(result))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchSiteList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.demos.get_site_list(
type="page",
filter={
"TYPE": "page",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'landing.demos.getSiteList',
[
'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 site demo list: ' . $e->getMessage();
}
BX24.callMethod(
'landing.demos.getSiteList',
{
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.getSiteList',
[
'type' => 'page',
'filter' => [
'TYPE' => 'page',
],
]
);
echo '<pre>';
print_r($result);
echo '</pre>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.demos.getSiteList", b24.Params{
"type": "page",
"filter": b24.Params{
"TYPE": "page",
},
})
if err != nil {
return fmt.Errorf("landing.demos.getSiteList: %w", err)
}
// Метод заворачивает ответ в объект с ключом "empty".
raw, ok := b24.Unwrap(res.Result, "empty")
if !ok {
return fmt.Errorf("в ответе нет ключа empty")
}
var item struct {
ID string `json:"ID"`
XMLID string `json:"XML_ID"`
Title string `json:"TITLE"`
Active bool `json:"ACTIVE"`
Publication bool `json:"PUBLICATION"`
LockDelete bool `json:"LOCK_DELETE"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.XMLID)
Ответ
HTTP-статус: 200
{
"result": {
"empty": {
"ID": "empty",
"XML_ID": "empty",
"TYPE": ["KNOWLEDGE", "GROUP", "PAGE", "MAINPAGE"],
"TITLE": "Пустой шаблон",
"ACTIVE": true,
"PUBLICATION": false,
"LOCK_DELETE": false,
"AVAILABLE": true,
"SINGLETON": false,
"SECTION": [],
"DESCRIPTION": "Создайте собственный сайт с чистого листа и привлекайте клиентов!",
"PREVIEW": "//bitrix24.ru/bitrix/components/bitrix/landing.demo/data/site/empty/preview.jpg",
"PREVIEW2X": "//bitrix24.ru/bitrix/components/bitrix/landing.demo/data/site/empty/preview@2x.jpg",
"PREVIEW3X": "//bitrix24.ru/bitrix/components/bitrix/landing.demo/data/site/empty/preview@3x.jpg",
"APP_CODE": "",
"REST": 0,
"DATA": {
"name": "Пустой шаблон",
"items": [],
"encoded": true,
"charset": "UTF-8"
}
}
},
"time": {
"start": 1774623040,
"finish": 1774623040.337361,
"duration": 0.33736109733581543,
"processing": 0,
"date_start": "2026-03-27T17:50:40+03:00",
"date_finish": "2026-03-27T17:50:40+03:00",
"operating_reset_at": 1774623640,
"operating": 0
}
}
Возвращаемые данные
result
object
Карта демо-шаблонов сайтов в формате:
{
"template_code": site_template
}
где:
- template_code — код шаблона
- site_template — объект шаблона подробнее
Если подходящих шаблонов нет, метод возвращает пустой массив result: [].
Состав полей шаблонов может отличаться и зависит от конкретного шаблона
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_ARGUMENT",
"error_description": "The value of an argument 'filter' has an invalid type",
"argument": "filter"
}
| Код | Описание | Значение |
|---|---|---|
ERROR_ARGUMENT |
The value of an argument 'filter' has an invalid type | Параметр filter передан в неверном типе |
MISSING_PARAMS |
Недостаточно параметров вызова | Не передан обязательный параметр type |
ACCESS_DENIED |
Недостаточно прав | Пользователь не прошел общие проверки доступа модуля Landing |
TYPE_ERROR |
Ошибка типа данных | Вызов метода с некорректным типом параметров |
SYSTEM_ERROR |
Внутренняя ошибка | Ошибка при выполнении метода на стороне сервера |

