Получить список шаблонов представления landing.template.getlist
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
landingКто может выполнять метод: пользователь с правом доступа к разделу «Сайты и магазины»
Метод landing.template.getlist получает список шаблонов представления текущего портала по параметрам выборки.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
params |
Объект параметров выборки шаблонов представления формата:
Список доступных полей описан ниже |
Параметр params
|
Название |
Описание |
|
select |
Список полей из полей объекта Шаблон представления. Если параметр не передан, метод возвращает все доступные поля шаблона. Поля вида |
|
filter |
Фильтр по полям из полей объекта Шаблон представления. Если параметр не передан, метод возвращает все шаблоны текущего портала, включая неактивные. Поля вида |
|
order |
Сортировка в формате Можно передать несколько полей. Если параметр не передан, метод не задает собственную сортировку |
|
group |
Массив имен полей для группировки, например Вычисляемые поля через |
|
limit |
Максимальное количество элементов в ответе. Если |
|
offset |
Смещение от начала выборки. Используйте вместе с |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": [
"ID",
"TITLE",
"XML_ID",
"SORT",
"ACTIVE",
"DATE_MODIFY"
],
"filter": {
"=ACTIVE": "Y"
},
"order": {
"SORT": "ASC",
"ID": "ASC"
},
"limit": 2,
"offset": 0
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.getlist.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": [
"ID",
"TITLE",
"XML_ID",
"SORT",
"ACTIVE",
"DATE_MODIFY"
],
"filter": {
"=ACTIVE": "Y"
},
"order": {
"SORT": "ASC",
"ID": "ASC"
},
"limit": 2,
"offset": 0
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.template.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 template item returned in result[]
type TemplateItem = {
ID: string
TITLE: string
XML_ID: string
SORT: string
ACTIVE: string
DATE_MODIFY: string
}
try {
// landing.template.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<TemplateItem[]>({
method: 'landing.template.getlist',
params: {
params: {
select: [
'ID',
'TITLE',
'XML_ID',
'SORT',
'ACTIVE',
'DATE_MODIFY',
],
filter: {
'=ACTIVE': 'Y',
},
order: {
SORT: 'ASC',
ID: 'ASC',
},
limit: 2,
offset: 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('Templates count:', 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 getTemplateList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// landing.template.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.template.getlist',
params: {
params: {
select: [
'ID',
'TITLE',
'XML_ID',
'SORT',
'ACTIVE',
'DATE_MODIFY',
],
filter: {
'=ACTIVE': 'Y',
},
order: {
SORT: 'ASC',
ID: 'ASC',
},
limit: 2,
offset: 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('Templates count:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTemplateList)
</script>
try {
$response = $b24Service
->core
->call(
'landing.template.getlist',
[
'params' => [
'select' => [
'ID',
'TITLE',
'XML_ID',
'SORT',
'ACTIVE',
'DATE_MODIFY',
],
'filter' => [
'=ACTIVE' => 'Y',
],
'order' => [
'SORT' => 'ASC',
'ID' => 'ASC',
],
'limit' => 2,
'offset' => 0,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting template list: ' . $e->getMessage();
}
BX24.callMethod(
'landing.template.getlist',
{
params: {
select: [
'ID',
'TITLE',
'XML_ID',
'SORT',
'ACTIVE',
'DATE_MODIFY'
],
filter: {
'=ACTIVE': 'Y'
},
order: {
SORT: 'ASC',
ID: 'ASC'
},
limit: 2,
offset: 0
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.template.getlist',
[
'params' => [
'select' => [
'ID',
'TITLE',
'XML_ID',
'SORT',
'ACTIVE',
'DATE_MODIFY',
],
'filter' => [
'=ACTIVE' => 'Y',
],
'order' => [
'SORT' => 'ASC',
'ID' => 'ASC',
],
'limit' => 2,
'offset' => 0,
],
]
);
if (isset($result['error']))
{
echo 'Ошибка: ' . $result['error_description'];
}
else
{
echo '<pre>';
print_r($result['result']);
echo '</pre>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.template.getlist", b24.Params{
"params": b24.Params{
"select": []string{"ID", "TITLE", "XML_ID", "SORT", "ACTIVE", "DATE_MODIFY"},
"filter": b24.Params{
"=ACTIVE": "Y",
},
"order": b24.Params{
"SORT": "ASC",
"ID": "ASC",
},
"limit": 2,
"offset": 0,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("landing.template.getlist: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Title string `json:"TITLE"`
XMLID string `json:"XML_ID"`
Sort string `json:"SORT"`
Active string `json:"ACTIVE"`
DateModify string `json:"DATE_MODIFY"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "1",
"TITLE": "С шапкой и подвалом",
"XML_ID": "header_footer",
"SORT": "100",
"ACTIVE": "Y",
"DATE_MODIFY": "10/10/2022 03:25:30 pm"
},
{
"ID": "2",
"TITLE": "С сайдбаром слева",
"XML_ID": "sidebar_left",
"SORT": "200",
"ACTIVE": "Y",
"DATE_MODIFY": "10/10/2022 03:25:30 pm"
}
],
"time": {
"start": 1774765200,
"finish": 1774765200.411258,
"duration": 0.4112579822540283,
"processing": 0,
"date_start": "2026-03-29T10:00:00+03:00",
"date_finish": "2026-03-29T10:00:00+03:00",
"operating_reset_at": 1774765800,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список шаблонов представления (подробное описание). Если по фильтру ничего не найдено, метод возвращает |
|
time |
Информация о времени выполнения запроса |
Объект template
|
Название |
Описание |
|
Поле шаблона представления из полей объекта Шаблон представления, если оно попало в выборку. Для полей |
Особенности ответа:
- Поле
TITLEобычно возвращается как название на текущем языке портала - Если для системного шаблона не найден перевод, в
TITLEможет вернуться языковой ключ вида#...#, например#HEADER_ONLY#
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Недостаточно прав."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для работы с разделом «Сайты и магазины» |
|
|
Ошибка типа данных при обработке параметров вызова |
|
|
Внутренняя ошибка при выполнении метода |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список включаемых областей для страницы landing.template.getLandingRef
- Получить список включаемых областей для сайта landing.template.getSiteRef
- Установить включаемые области для страницы landing.template.setLandingRef
- Установить включаемые области для сайта landing.template.setSiteRef
- Поля объекта Шаблон представления