Получить список виджетов landing.repowidget.getlist

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

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

Scope: landing

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

Метод landing.repowidget.getlist возвращает список виджетов текущего приложения, отобранных по фильтру.

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

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

Название `тип`	Описание
params* `object`	Массив полей для получения списка виджетов

Параметр params

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

Название `тип`	Описание
select `array`	Массив со списком полей, которые необходимо выбрать. Если не передан или передан пустой массив, то будут выбраны все доступные доступные виджеты
filter `object`	Объект для фильтрации выбранных записей в формате `{"field_1": "value_1", ... "field_N": "value_N"}`. Возможные значения для `field` смотрите в таблице ниже. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: `>=` — больше либо равно `>` — больше `<=` — меньше либо равно `<` — меньше `@` — IN (в качестве значения передаётся массив) `!@`— NOT IN (в качестве значения передаётся массив) `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры: "мол%" — ищем значения, начинающиеся с «мол» "%мол" — ищем значения, заканчивающиеся на «мол» "%мол%" — ищем значения, где «мол» может быть в любой позиции `%=` — LIKE (см. описание выше) `!%` — NOT LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск идет с обоих сторон. `!=%` — NOT LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры: "мол%" — ищем значения, не начинающиеся с «мол» "%мол" — ищем значения, не заканчивающиеся на «мол» "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции `!%=` — NOT LIKE (см. описание выше) `=` — равно, точное совпадение (используется по умолчанию) `!=` - не равно `!` — не равно
group `array`	Массив для группировки виджетов. Группировать можно по полям виджета
order `object`	Объект для сортировки выбранных записей в формате `{"field_1": "order_1", ... "field_N": "order_N"}`. Возможные значения для `field` смотрите в таблице ниже. Возможные значения для `order`: `asc` — в порядке возрастания `desc` — в порядке убывания

Поля field

Поля объекта виджета. Присутствуют в запросе и ответе.

Название `тип`	Описание
ID `integer`	Идентификатор виджета
XML_ID `string`	Уникальный код записи
APP_CODE `string`	Код текущего приложения
ACTIVE `char`	Активность виджета. Принимает значения: `Y` - виджет активен и доступен `N` - виджет неактивен и недоступен
NAME `string`	Название виджета
DESCRIPTION `string`	Описание виджета
SECTIONS `string`	Код раздела, в который будет добавлен виджет
PREVIEW `string`	URL картинки-обложки виджета для слайдера выбора виджетов
WIDGET_PARAMS `object`	Параметры для vue-шаблонизатора
CONTENT `string`	Верстка виджета с использованием конструкций Vue
MANIFEST `object`	Манифест виджета
CREATED_BY_ID `integer`	Идентификатор пользователя, создавшего запись
MODIFIED_BY_ID `integer`	Идентификатор пользователя, изменившего запись
DATE_CREATE `date`	Дата создания
DATE_MODIFY `date`	Дата изменения
SITE_TEMPLATE_ID `string`	Привязка виджета к определенному шаблону сайта. Только для коробочного Битрикс24!

Примеры кода

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

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

// 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 widget returned in result[]
type RepoWidgetItem = {
  ID: string
  XML_ID: string
  APP_CODE: string
  ACTIVE: 'Y' | 'N'
  NAME: string
  DESCRIPTION: string | null
  SECTIONS: string
  SITE_TEMPLATE_ID: string | null
  PREVIEW: string
  MANIFEST: Record<string, unknown>
  CONTENT: string
  CREATED_BY_ID: string
  MODIFIED_BY_ID: string
  DATE_CREATE: string
  DATE_MODIFY: string
}

try {
  // landing.repowidget.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<RepoWidgetItem[]>({
    method: 'landing.repowidget.getlist',
    params: {
      params: {
        select: ['ID', 'NAME'],
        filter: {
          '>ID': '1',
        },
      },
      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('Widgets count on this page:', 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 getRepoWidgetList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // landing.repowidget.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.repowidget.getlist',
        params: {
          params: {
            select: ['ID', 'NAME'],
            filter: {
              '>ID': '1',
            },
          },
          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('Widgets count on this page:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getRepoWidgetList)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.landing.repowidget.getlist(
        params={
            "select": [
                "ID",
                "NAME",
            ],
            "filter": {
                ">ID": "1",
            },
        },
    ).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.repowidget.getlist',
            [
                'params' => [
                    'select' => [
                        'ID', 'NAME'
                    ],
                    'filter' => [
                        '>ID' => '1'
                    ]
                ]
            ]
        );

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

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting repowidget list: ' . $e->getMessage();
}

BX24.callMethod(
    'landing.repowidget.getlist',
    {
        params: {
            select: [
                'ID', 'NAME' 
            ],
            filter: {
                '>ID': '1'
            }
        }
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.info(result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'landing.repowidget.getList',
    [
        'params' => [
            'select' => ['ID', 'NAME'],
            'filter' => [
                '>ID' => '1'
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

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

HTTP-статус: 200

{
    "result": [
        {
            "ID": "4",
            "XML_ID": "my_widget",
            "APP_CODE": "app.code",
            "ACTIVE": "Y",
            "NAME": "My widget",
            "DESCRIPTION": null,
            "SECTIONS": "widgets_company_life",
            "SITE_TEMPLATE_ID": null,
            "PREVIEW": "https://my-app.com/main_preview.jpg",
            "MANIFEST": {
                "block": {
                    "type": [
                        "mainpage"
                    ],
                    "subtype": [
                        "widgetvue"
                    ],
                    "subtype_params": {
                        "rootNode": ".w-container",
                        "demoData": {
                            "desc": "JustSome widget data",
                            "count": "420",
                        },
                        "handler": "https://my-app.com/main.php",
                        "style": "https://my-app.com/main.css",
                        "lang": {
                            "ru": {
                                "W_TITLE": "Люди и их возраст",
                                "W_EMPTY": "Нет людей"
                            },
                            "en": {
                                "W_TITLE": "Widget title",
                                "W_EMPTY": "Empty!"
                            }
                        }
                    }
                }
            },
            "CONTENT": "<div class=\"w-container\">{{desc}}</div>",
            "CREATED_BY_ID": "1",
            "MODIFIED_BY_ID": "1",
            "DATE_CREATE": "10.10.2024 15:55:30",
            "DATE_MODIFY": "16.10.2024 16:12:57"
        }
    ],
    "time": {
        "start": 1729162340.81773,
        "finish": 1729162344.800994,
        "duration": 3.9832639694213867,
        "processing": 3.8990869522094727,
        "date_start": "2024-10-17T15:52:20+05:00",
        "date_finish": "2024-10-17T15:52:24+05:00",
        "operating": 3.899045944213867
    }
}

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

Название `тип`	Описание
result `object`	Массив виджетов. Каждый элемент массива — объект, допустимые поля описаны выше.
time `time`	Информация о времени выполнения запроса

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

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

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

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

Была ли статья полезна?

Удалить виджет

Включить режим отладки

Получить список виджетов landing.repowidget.getlist

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

Параметр paramsПараметр params

Поля fieldПоля field

Примеры кодаПримеры кода

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

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

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

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

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