Получить список сайтов landing.site.getList

Scope: landing

Кто может выполнять метод: пользователь с правом «просмотр» сайтов

Метод landing.site.getList получает список сайтов по параметрам выборки.

Важно

По умолчанию в выборку попадают только сайты с DELETED = "N". Чтобы получить удаленные сайты, передайте в фильтре DELETED или =DELETED

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

scope
string

Внутренний скоуп лендингов. Он не связан с REST-скоупом landing в названии метода.

Для GROUP, KNOWLEDGE и MAINPAGE передают соответствующий scope (подробное описание)

params
object

Параметры выборки сайтов (подробное описание)

Параметр params

Название
тип

Описание

select
string[]

Список полей для выборки из базовых полей сайта. Если параметр не передан или передан не массив, используется ["*"]. Метод всегда добавляет в выборку ID и TYPE

filter
object

Фильтр по полям из базовых полей сайта. Если параметр не передан или передан не массив, используется пустой фильтр {}.

Если в параметре TYPE или =TYPE указано значение STORE, публичный метод преобразует его в ["STORE", "SMN"].

Точная фильтрация по типу работает только для одного значения, которое разрешено в текущем внутреннем scope. Если передан массив или значение, недоступное в текущем scope, метод подставит список разрешенных типов

order
object

Сортировка в формате {"FIELD": "ASC DESC"}. Если параметр не передан, специальная сортировка не применяется

group
array

Группировка в формате ORM. Если передан не массив, параметр приводится к пустому массиву. При фильтрации по правам доступа в группировку добавляется ID

limit
integer

Ограничение количества строк выборки на уровне ORM. По умолчанию не задано

offset
integer

Смещение выборки на уровне ORM. Если параметр не передан, применяется поведение ORM по умолчанию

Соответствие TYPE и scope

Типы сайтов и правила выбора параметра scope описаны в статье Работа с типами сайтов и скоупами.
Таблица ниже применима к params.filter.TYPE и params.filter.=TYPE

params.filter.TYPE

scope в запросе

Когда использовать

PAGE, STORE, SMN

не передавать

Выборка сайтов и магазинов в стандартном scope

GROUP

GROUP

Выборка сайтов групп

KNOWLEDGE

KNOWLEDGE

Выборка баз знаний

MAINPAGE

MAINPAGE

Выборка Главной страницы

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": [
                "ID",
                "TITLE",
                "TYPE"
              ],
              "filter": {
                "=DELETED": "N"
              },
              "order": {
                "ID": "DESC"
              }
            }
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getList.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "params": {
              "select": [
                "ID",
                "TITLE",
                "TYPE"
              ],
              "filter": {
                "=DELETED": "N"
              },
              "order": {
                "ID": "DESC"
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.getList.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.site.getList',
        		{
        			params: {
        				select: [
        					'ID',
        					'TITLE',
        					'TYPE'
        				],
        				filter: {
        					'=DELETED': 'N'
        				},
        				order: {
        					ID: 'DESC'
        				}
        			}
        		}
        	);
        
        	const result = response.getData();
        	console.info(result.result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.getList',
                    [
                        'params' => [
                            'select' => [
                                'ID',
                                'TITLE',
                                'TYPE',
                            ],
                            'filter' => [
                                '=DELETED' => 'N',
                            ],
                            'order' => [
                                'ID' => 'DESC',
                            ],
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting site list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.site.getList',
            {
                params: {
                    select: [
                        'ID',
                        'TITLE',
                        'TYPE'
                    ],
                    filter: {
                        '=DELETED': 'N'
                    },
                    order: {
                        ID: 'DESC'
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.getList',
            [
                'params' => [
                    'select' => [
                        'ID',
                        'TITLE',
                        'TYPE',
                    ],
                    'filter' => [
                        '=DELETED' => 'N',
                    ],
                    'order' => [
                        'ID' => 'DESC',
                    ],
                ]
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "157",
                    "TITLE": "Вилла Ранду",
                    "TYPE": "PAGE"
                },
                {
                    "ID": "147",
                    "TITLE": "Test Test yesss",
                    "TYPE": "STORE"
                },
                {
                    "ID": "3",
                    "TITLE": "Музей вилок",
                    "TYPE": "PAGE"
                }
            ],
            "time": {
                "start": 1773269838,
                "finish": 1773269838.647153,
                "duration": 0.6471529006958008,
                "processing": 0,
                "date_start": "2026-03-12T01:57:18+03:00",
                "date_finish": "2026-03-12T01:57:18+03:00",
                "operating_reset_at": 1773270438,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object[]

Список сайтов (подробное описание). Метод может вернуть result: [] без ошибки, если по фильтру нет подходящих сайтов или у пользователя нет права «просмотр» для этих сайтов

time
time

Информация о времени выполнения запроса

Объект site

Название
тип

Описание

ID
string

Идентификатор сайта. Поле всегда присутствует в ответе

TYPE
string

Тип сайта. Поле всегда присутствует в ответе

DOMAIN_NAME
string

Домен сайта, возвращается при выборе поля DOMAIN_NAME

PUBLIC_URL
string

Публичный URL сайта, возвращается при выборе поля PUBLIC_URL.

Может быть пустой строкой, если URL не удалось определить

PREVIEW_PICTURE
string

URL превью главной страницы сайта, возвращается при выборе поля PREVIEW_PICTURE. Может быть пустой строкой, если превью недоступно

PHONE
string | null

Телефон компании из CRM, возвращается при выборе поля PHONE

DATE_CREATE
string

Дата создания в строковом формате, возвращается при выборе поля DATE_CREATE

DATE_MODIFY
string

Дата изменения в строковом формате, возвращается при выборе поля DATE_MODIFY

LANDING_ID_INDEX
string | null

Может присутствовать, если в select запрошено PREVIEW_PICTURE

Обработка ошибок

HTTP-статус: 400

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

ACCESS_DENIED

Недостаточно прав для вызова методов landing

TYPE_ERROR

Ошибка типа данных в параметрах вызова метода

SYSTEM_ERROR

Внутренняя ошибка при выполнении метода

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить папки сайта
Следующая
Получить URL превью сайта