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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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"
// 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 site item returned in result[]
type SiteItem = {
  ID: string
  TITLE: string
  TYPE: string
}

try {
  // landing.site.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<SiteItem[]>({
    method: 'landing.site.getList',
    params: {
      params: {
        select: [
          'ID',
          'TITLE',
          'TYPE',
        ],
        filter: {
          '=DELETED': 'N',
        },
        order: {
          ID: 'DESC',
        },
      },
      start: 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('Sites fetched:', 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 getSiteList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // landing.site.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.site.getList',
        params: {
          params: {
            select: [
              'ID',
              'TITLE',
              'TYPE',
            ],
            filter: {
              '=DELETED': 'N',
            },
            order: {
              ID: 'DESC',
            },
          },
          start: 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('Sites fetched:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getSiteList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.landing.site.get_list(
        params={
            "select": [
                "ID",
                "TITLE",
                "TYPE",
            ],
            "filter": {
                "=DELETED": "N",
            },
            "order": {
                "ID": "DESC",
            },
        },
    ).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.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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.site.getList", b24.Params{
	"params": b24.Params{
		"select": []string{"ID", "TITLE", "TYPE"},
		"filter": b24.Params{
			"=DELETED": "N",
		},
		"order": b24.Params{
			"ID": "DESC",
		},
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("landing.site.getList: %w", err)
}

var items []struct {
	ID    b24.ID `json:"ID"`
	Title string `json:"TITLE"`
	Type  string `json:"TYPE"`
}
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": "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
string

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

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

Код

Описание

ACCESS_DENIED

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

TYPE_ERROR

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

SYSTEM_ERROR

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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