метод REST scope: landing

landing.site.getList

Получить список сайтов

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

Описание

Метод 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

params.filter.TYPE необязательный

scope в запросе

PAGE, STORE, SMN необязательный

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

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"

Ответ

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

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

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

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied"
}
Код Описание Значение
ACCESS_DENIED Недостаточно прав для вызова методов landing
TYPE_ERROR Ошибка типа данных в параметрах вызова метода
SYSTEM_ERROR Внутренняя ошибка при выполнении метода

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.