Получить список страниц landing.landing.getList
Scope:
landingКто может выполнять метод: пользователь с правом «просмотр» сайта
Метод landing.landing.getList получает список страниц по параметрам выборки.
Важно
По умолчанию метод возвращает только страницы на неудаленных сайтах с DELETED = "N". Чтобы получить удаленные страницы, передайте в фильтре DELETED или =DELETED. Это работает только для страниц на неудаленных сайтах: страницы удаленных сайтов метод не возвращает
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
scope |
Внутренний скоуп лендингов. Он не связан с REST-скоупом Для обычных страниц параметр не нужен. Для |
|
params |
Параметры выборки страниц (подробное описание) |
Параметр params
|
Название |
Описание |
|
select |
Список полей для выборки из полей объекта Страница. Если параметр не передан или равен Метод принимает только простые имена полей страницы. Элементы с |
|
filter |
Фильтр по полям из полей объекта Страница. Если параметр не передан или передан в неверном формате, выборка выполняется без пользовательских условий. Ключи с Если в фильтре передан Идентификатор сайта можно получить методом landing.site.getList |
|
order |
Сортировка в формате |
|
group |
Группировка в формате ORM. Собственного значения по умолчанию у метода нет |
|
limit |
Ограничение количества строк выборки на уровне ORM. Метод не задает собственный лимит по умолчанию |
|
offset |
Смещение выборки на уровне ORM |
|
Если значение приводится к |
|
|
Если значение приводится к |
|
|
Если значение приводится к |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": [
"ID",
"TITLE",
"SITE_ID",
"DATE_MODIFY"
],
"filter": {
"SITE_ID": 205,
"=DELETED": "N"
},
"order": {
"ID": "DESC"
},
"get_urls": true,
"get_preview": true,
"check_area": true
}
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.landing.getList.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"params": {
"select": [
"ID",
"TITLE",
"SITE_ID",
"DATE_MODIFY"
],
"filter": {
"SITE_ID": 205,
"=DELETED": "N"
},
"order": {
"ID": "DESC"
},
"get_urls": true,
"get_preview": true,
"check_area": true
},
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.landing.getList.json"
try
{
const response = await $b24.callMethod(
'landing.landing.getList',
{
params: {
select: [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY'
],
filter: {
SITE_ID: 205,
'=DELETED': 'N'
},
order: {
ID: 'DESC'
},
get_urls: true,
get_preview: true,
check_area: true
}
}
);
const result = response.getData();
console.info(result.result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'landing.landing.getList',
[
'params' => [
'select' => [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY',
],
'filter' => [
'SITE_ID' => 205,
'=DELETED' => 'N',
],
'order' => [
'ID' => 'DESC',
],
'get_urls' => true,
'get_preview' => true,
'check_area' => true,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting landing list: ' . $e->getMessage();
}
BX24.callMethod(
'landing.landing.getList',
{
params: {
select: [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY'
],
filter: {
SITE_ID: 205,
'=DELETED': 'N'
},
order: {
ID: 'DESC'
},
get_urls: true,
get_preview: true,
check_area: true
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.landing.getList',
[
'params' => [
'select' => [
'ID',
'TITLE',
'SITE_ID',
'DATE_MODIFY',
],
'filter' => [
'SITE_ID' => 205,
'=DELETED' => 'N',
],
'order' => [
'ID' => 'DESC',
],
'get_urls' => true,
'get_preview' => true,
'check_area' => true,
],
]
);
echo '<pre>';
print_r($result);
echo '</pre>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "985",
"TITLE": "Новость детально",
"SITE_ID": "3",
"DATE_MODIFY": "10/10/2022 03:25:30 pm",
"DOMAIN_ID": "5"
},
{
"ID": "573",
"TITLE": "Page vide",
"SITE_ID": "3",
"DATE_MODIFY": "10/10/2022 03:25:30 pm",
"DOMAIN_ID": "5"
}
],
"time": {
"start": 1773712560,
"finish": 1773712560.955928,
"duration": 0.9559280872344971,
"processing": 0,
"date_start": "2026-03-17T04:56:00+03:00",
"date_finish": "2026-03-17T04:56:00+03:00",
"operating_reset_at": 1773713160,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список страниц (подробное описание). Метод может вернуть |
|
time |
Информация о времени выполнения запроса |
Объект page
|
Название |
Описание |
|
FIELD |
Любое поле страницы из полей объекта Страница, если оно запрошено в |
|
DOMAIN_ID |
Идентификатор домена сайта, к которому привязана страница. Присутствует в ответе, даже если оно не указано в |
|
PUBLIC_URL |
Публичный адрес страницы. Возвращается только если включен флаг |
|
PREVIEW |
Ссылка на превью страницы. Возвращается только если включен флаг |
|
IS_AREA |
Признак того, что страница используется как включаемая область. Возвращается только если включен флаг |
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для вызова метода |
|
|
Ошибка типа данных в параметрах вызова метода |
|
|
Внутренняя ошибка при выполнении метода |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить страницу или папку landing.landing.add
- Изменить страницу landing.landing.update
- Удалить страницу landing.landing.delete
- Получить дополнительные поля страницы landing.landing.getadditionalfields
- Получить URL превью страницы landing.landing.getpreview
- Получить публичный URL страницы landing.landing.getpublicurl