Получить список сайтов landing.site.getList
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
landingКто может выполнять метод: пользователь с правом «просмотр» сайтов
Метод landing.site.getList получает список сайтов по параметрам выборки.
Важно
По умолчанию в выборку попадают только сайты с DELETED = "N". Чтобы получить удаленные сайты, передайте в фильтре DELETED или =DELETED
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
scope |
Внутренний скоуп лендингов. Он не связан с REST-скоупом Для |
|
params |
Параметры выборки сайтов (подробное описание) |
Параметр params
|
Название |
Описание |
|
select |
Список полей для выборки из базовых полей сайта. Если параметр не передан или передан не массив, используется |
|
filter |
Фильтр по полям из базовых полей сайта. Если параметр не передан или передан не массив, используется пустой фильтр Если в параметре Точная фильтрация по типу работает только для одного значения, которое разрешено в текущем внутреннем |
|
order |
Сортировка в формате |
|
group |
Группировка в формате ORM. Если передан не массив, параметр приводится к пустому массиву. При фильтрации по правам доступа в группировку добавляется |
|
limit |
Ограничение количества строк выборки на уровне ORM. По умолчанию не задано |
|
offset |
Смещение выборки на уровне ORM. Если параметр не передан, применяется поведение ORM по умолчанию |
Соответствие TYPE и scope
Типы сайтов и правила выбора параметра scope описаны в статье Работа с типами сайтов и скоупами.
Таблица ниже применима к params.filter.TYPE и params.filter.=TYPE
|
params.filter.TYPE |
scope в запросе |
Когда использовать |
|
|
не передавать |
Выборка сайтов и магазинов в стандартном |
|
|
|
Выборка сайтов групп |
|
|
|
Выборка баз знаний |
|
|
|
Выборка главной страницы или вайба |
Примеры кода
Как использовать примеры в документации
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>
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 |
Список сайтов (подробное описание). Метод может вернуть |
|
time |
Информация о времени выполнения запроса |
Объект site
|
Название |
Описание |
|
ID |
Идентификатор сайта. Поле всегда присутствует в ответе |
|
TYPE |
Тип сайта. Поле всегда присутствует в ответе |
|
DOMAIN_NAME |
Домен сайта, возвращается при выборе поля |
|
PUBLIC_URL |
Публичный URL сайта, возвращается при выборе поля Может быть пустой строкой, если URL не удалось определить |
|
PREVIEW_PICTURE |
URL превью главной страницы сайта, возвращается при выборе поля |
|
PHONE |
Телефон компании из CRM, возвращается при выборе поля |
|
DATE_CREATE |
Дата создания в строковом формате, возвращается при выборе поля |
|
DATE_MODIFY |
Дата изменения в строковом формате, возвращается при выборе поля |
|
LANDING_ID_INDEX |
Может присутствовать, если в |
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для вызова методов landing |
|
|
Ошибка типа данных в параметрах вызова метода |
|
|
Внутренняя ошибка при выполнении метода |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |