Получить список страниц landing.landing.getList

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

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

Scope: landing

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

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

Важно

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

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

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

Название
тип

Описание

scope
string

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

Для обычных страниц параметр не нужен. Для GROUP, KNOWLEDGE и MAINPAGE передают соответствующий scope. Подробнее о выборе значения в статье Работа с типами сайтов и скоупами

params
object

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

Параметр params

Название
тип

Описание

select
string[]

Список полей для выборки из полей объекта Страница. Если параметр не передан или равен null, используется ["*"].

Метод принимает только простые имена полей страницы. Элементы с . игнорируются

filter
object

Фильтр по полям из полей объекта Страница. Если параметр не передан или передан в неверном формате, выборка выполняется без пользовательских условий. Ключи с . и CHECK_PERMISSIONS игнорируются.

Если в фильтре передан SITE_ID, метод дополнительно исключает страницы, которые находятся в папках этого сайта, помеченных как удаленные.

Идентификатор сайта можно получить методом landing.site.getList

order
object

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

group
array

Группировка в формате ORM. Собственного значения по умолчанию у метода нет

limit
integer

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

offset
integer

Смещение выборки на уровне ORM

get_preview
boolean | integer

Если значение приводится к true, в каждый элемент результата добавляется поле PREVIEW со ссылкой на превью страницы

get_urls
boolean | integer

Если значение приводится к true, в каждый элемент результата добавляется поле PUBLIC_URL с публичным адресом страницы

check_area
boolean | integer

Если значение приводится к true, в каждый элемент результата добавляется поле IS_AREA, которое показывает, является ли страница включаемой областью

Примеры кода

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

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"
        
// 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 LandingItem returned in result[]
        type LandingItem = {
          ID: string
          TITLE: string
          SITE_ID: string
          DATE_MODIFY: string
          DOMAIN_ID: string | null
          PUBLIC_URL?: string | null
          PREVIEW?: string | null
          IS_AREA?: boolean
        }
        
        try {
          // landing.landing.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<LandingItem[]>({
            method: 'landing.landing.getList',
            params: {
              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,
              },
              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('Pages count:', result.length, 'First page:', result[0])
          }
        } 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 getLandingList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // landing.landing.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.landing.getList',
                params: {
                  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,
                  },
                  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('Pages count:', result.length, 'First page:', result[0])
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getLandingList)
        </script>
        
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>';
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        res, err := client.Core().Call(ctx, "landing.landing.getList", b24.Params{
        	"params": b24.Params{
        		"select": []string{"ID", "TITLE", "SITE_ID", "DATE_MODIFY"},
        		"filter": b24.Params{
        			"SITE_ID":  205,
        			"=DELETED": "N",
        		},
        		"order": b24.Params{
        			"ID": "DESC",
        		},
        		"get_urls":    true,
        		"get_preview": true,
        		"check_area":  true,
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("landing.landing.getList: %w", err)
        }
        
        var items []struct {
        	ID         b24.ID `json:"ID"`
        	Title      string `json:"TITLE"`
        	SiteID     b24.ID `json:"SITE_ID"`
        	DateModify string `json:"DATE_MODIFY"`
        	DomainID   b24.ID `json:"DOMAIN_ID"`
        }
        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": "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
object[]

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

time
time

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

Объект page

Название
тип

Описание

FIELD
string | null

Любое поле страницы из полей объекта Страница, если оно запрошено в params.select или если params.select не передан

DOMAIN_ID
string | null

Идентификатор домена сайта, к которому привязана страница. Присутствует в ответе, даже если оно не указано в params.select

PUBLIC_URL
string | null

Публичный адрес страницы. Возвращается только если включен флаг get_urls

PREVIEW
string | null

Ссылка на превью страницы. Возвращается только если включен флаг get_preview

IS_AREA
boolean

Признак того, что страница используется как включаемая область. Возвращается только если включен флаг check_area

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

ACCESS_DENIED

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

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

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

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