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

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

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

Scope: landing

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

Метод landing.site.getFolders возвращает список папок сайта.

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

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

Название
тип

Описание

scope
string

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

Значение scope должно соответствовать типу сайта (подробное описание)

siteId*
integer

Идентификатор сайта, для которого запрашиваются папки.

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

filter
object

Фильтр по полям папки (подробное описание)

Параметр filter

Название
тип

Описание

ID
integer

Идентификатор папки

PARENT_ID
integer | null

Идентификатор родительской папки. Если передать 0, null, false или пустую строку, значение будет приведено к null, это выборка папок верхнего уровня

INDEX_ID
integer

Идентификатор индексной страницы папки

ACTIVE
string

Флаг активности Y/N

DELETED
string

Флаг удаления Y/N

=DELETED
string

Точное сравнение флага удаления. Если в запросе нет DELETED и =DELETED, метод автоматически добавляет =DELETED: "N"

TITLE
string

Название папки

CODE
string

Символьный код папки

CREATED_BY_ID
integer

Идентификатор пользователя, создавшего папку

MODIFIED_BY_ID
integer

Идентификатор пользователя, изменившего папку

DATE_CREATE
datetime

Дата и время создания папки

DATE_MODIFY
datetime

Дата и время изменения папки

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "siteId": 1817,
    "filter": {
      "PARENT_ID": 0,
      "=DELETED": "N",
      "ACTIVE": "Y"
    }
  }' \
  "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getFolders.json"
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "siteId": 1817,
    "filter": {
      "PARENT_ID": 0,
      "=DELETED": "N",
      "ACTIVE": "Y"
    },
    "auth": "**put_access_token_here**"
  }' \
  "https://**put.your-domain-here**/rest/landing.site.getFolders.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 Folder returned in result[]
type Folder = {
  ID: string
  PARENT_ID: string | null
  SITE_ID: string
  INDEX_ID: string | null
  ACTIVE: string
  DELETED: string
  TITLE: string
  CODE: string
  CREATED_BY_ID: string
  MODIFIED_BY_ID: string
  DATE_CREATE: string
  DATE_MODIFY: string
}

try {
  // landing.site.getFolders 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<Folder[]>({
    method: 'landing.site.getFolders',
    params: {
      siteId: 1817,
      filter: {
        PARENT_ID: 0,
        '=DELETED': 'N',
        ACTIVE: 'Y',
      },
      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('Folders count:', result.length, 'First folder:', 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 getSiteFolders() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // landing.site.getFolders 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.getFolders',
        params: {
          siteId: 1817,
          filter: {
            PARENT_ID: 0,
            '=DELETED': 'N',
            ACTIVE: 'Y',
          },
          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('Folders count:', result.length, 'First folder:', result[0])
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

try:
    bitrix_response = client.landing.site.get_folders(
        site_id=1817,
        filter={
            "PARENT_ID": 0,
            "=DELETED": "N",
            "ACTIVE": "Y",
        },
    ).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.getFolders',
            [
                'siteId' => 1817,
                'filter' => [
                    'PARENT_ID' => 0,
                    '=DELETED' => 'N',
                    'ACTIVE' => 'Y',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting folders: ' . $e->getMessage();
}
BX24.callMethod(
    'landing.site.getFolders',
    {
        siteId: 1817,
        filter: {
            PARENT_ID: 0,
            '=DELETED': 'N',
            ACTIVE: 'Y'
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'landing.site.getFolders',
    [
        'siteId' => 1817,
        'filter' => [
            'PARENT_ID' => 0,
            '=DELETED' => 'N',
            'ACTIVE' => 'Y',
        ],
    ]
);

if (isset($result['error']))
{
    echo 'Ошибка: ' . $result['error_description'];
}
else
{
    echo '<pre>';
    print_r($result['result']);
    echo '</pre>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.site.getFolders", b24.Params{
	"siteId": 1817,
	"filter": b24.Params{
		"PARENT_ID": 0,
		"=DELETED":  "N",
		"ACTIVE":    "Y",
	},
})
if err != nil {
	return fmt.Errorf("landing.site.getFolders: %w", err)
}

var items []struct {
	ID      b24.ID `json:"ID"`
	SiteID  b24.ID `json:"SITE_ID"`
	IndexID b24.ID `json:"INDEX_ID"`
	Active  string `json:"ACTIVE"`
	Deleted string `json:"DELETED"`
	Title   string `json:"TITLE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.SiteID)
}

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

HTTP-статус: 200

{
    "result": [
        {
            "ID": "1",
            "PARENT_ID": null,
            "SITE_ID": "3",
            "INDEX_ID": "9",
            "ACTIVE": "Y",
            "DELETED": "N",
            "TITLE": "тест переноса страниц",
            "CODE": "change",
            "CREATED_BY_ID": "1",
            "MODIFIED_BY_ID": "29",
            "DATE_CREATE": "11/12/2021 08:39:53 pm",
            "DATE_MODIFY": "12/28/2021 03:04:04 pm"
        },
        {
            "ID": "33",
            "PARENT_ID": null,
            "SITE_ID": "3",
            "INDEX_ID": null,
            "ACTIVE": "Y",
            "DELETED": "N",
            "TITLE": "mobile",
            "CODE": "mobile",
            "CREATED_BY_ID": "29",
            "MODIFIED_BY_ID": "29",
            "DATE_CREATE": "12/08/2021 10:23:37 am",
            "DATE_MODIFY": "12/08/2021 10:24:48 am"
        },
        {
            "ID": "3",
            "PARENT_ID": null,
            "SITE_ID": "3",
            "INDEX_ID": "45",
            "ACTIVE": "Y",
            "DELETED": "N",
            "TITLE": "вложение 1",
            "CODE": "vlozhenie1",
            "CREATED_BY_ID": "1",
            "MODIFIED_BY_ID": "29",
            "DATE_CREATE": "11/12/2021 08:39:53 pm",
            "DATE_MODIFY": "12/03/2021 08:10:21 am"
        }
    ],
    "time": {
        "start": 1773257990,
        "finish": 1773257990.091689,
        "duration": 0.0916891098022461,
        "processing": 0,
        "date_start": "2026-03-11T22:39:50+03:00",
        "date_finish": "2026-03-11T22:39:50+03:00",
        "operating_reset_at": 1773258590,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object[]

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

time
time

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

Объект folder

Название
тип

Описание

ID
string

Идентификатор папки

PARENT_ID
string | null

Идентификатор родительской папки

SITE_ID
string

Идентификатор сайта

INDEX_ID
string | null

Идентификатор индексной страницы папки

ACTIVE
string

Флаг активности Y/N

DELETED
string

Флаг удаления Y/N

TITLE
string

Название папки

CODE
string

Символьный код папки

CREATED_BY_ID
string

Идентификатор пользователя, создавшего папку

MODIFIED_BY_ID
string

Идентификатор пользователя, изменившего папку

DATE_CREATE
string

Дата и время создания в строковом формате

DATE_MODIFY
string

Дата и время изменения в строковом формате

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

HTTP-статус: 400

{
    "error": "MISSING_PARAMS",
    "error_description": "Недостаточно параметров вызова, пропущены: siteId"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

MISSING_PARAMS

Не передан обязательный параметр siteId

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

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

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