Get the list of widgets landing.repowidget.getlist

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: landing

Who can execute the method: any user

The method landing.repowidget.getlist returns a list of Vibe widgets of the current application, filtered by the specified criteria. If the method is called via a webhook, it returns the widgets registered without an application.

The method returns all matching records in a single call. It does not support pagination via start.

Method Parameters

Name
type

Description

params
object

Selection parameters (detailed description).

If not passed, the method returns all widgets

Parameter params

Name `type`	Description
select `array`	Array with the list of fields to be selected. If not passed, all fields are selected. The `MANIFEST` field is always added to the selection, so with an empty array the method returns only this field
filter `object`	Object for filtering the selected records in the format `{"field_1": "value_1", ... "field_N": "value_N"}`. Possible values for `field` can be found in the table below. The method adds the `APP_CODE` condition to the filter itself. An additional prefix can be specified for the key to clarify the filter behavior. Possible prefix values: `>=` — greater than or equal to `>` — greater than `<=` — less than or equal to `<` — less than `@` — IN (an array is passed as the value) `!@` — NOT IN (an array is passed as the value) `%` — LIKE, substring search. The `%` symbol should not be included in the filter value. Finds the substring in any position of the string `=%` — LIKE, substring search. The `%` symbol must be included in the value. Examples: "mol%" — searching for values starting with "mol" "%mol" — searching for values ending with "mol" "%mol%" — searching for values where "mol" can be in any position `%=` — LIKE (see description above) `!%` — NOT LIKE, substring search. The `%` symbol should not be included in the filter value. Finds values that do not contain the substring in any position `!=%` — NOT LIKE, substring search. The `%` symbol must be included in the value. Examples: "mol%" — searching for values not starting with "mol" "%mol" — searching for values not ending with "mol" "%mol%" — searching for values where the substring "mol" is not present in any position `!%=` — NOT LIKE (see description above) `=` — equals, exact match (used by default) `!=` — not equal `!` — not equal
group `array`	Array for grouping widgets. Grouping can be done by fields of the widget
order `object`	Object for sorting the selected records in the format `{"field_1": "order_1", ... "field_N": "order_N"}`. Possible values for `field` can be found in the table below. Possible values for `order`: `asc` — in ascending order `desc` — in descending order
limit `integer`	Maximum number of records in the selection. The limit applies to all blocks of the application in the repository, including blocks added with the landing.repo.register method. Vibe widgets are selected after that, so with `limit: 10` the method can return fewer than 10 widgets
offset `integer`	Number of records to skip from the start of the selection. Used together with `limit`

Fields field

Fields of the widget object. You can pass them in select, filter, order, and group, and they are also returned in the response. The numeric fields ID, CREATED_BY_ID, and MODIFIED_BY_ID are returned as strings.

Name `type`	Description
ID `integer`	Widget identifier
XML_ID `string`	Unique record code
APP_CODE `string`	Code of the current application
ACTIVE `char`	Widget activity. Accepts values: `Y` — widget is active and available `N` — widget is inactive and unavailable
NAME `string`	Widget name
DESCRIPTION `string`	Widget description
SECTIONS `string`	Code of the section where the widget will be added
PREVIEW `string`	URL of the widget cover image for the widget selection slider
CONTENT `string`	Widget markup using Vue constructs
MANIFEST `object`	Widget manifest. Contains: `block.type` — `["vibe"]` `block.subtype` — `widgetvue` as a string or as the array `["widgetvue"]` `block.subtype_params` — parameters from `WIDGET_PARAMS` passed during registration: `rootNode`, `demoData`, `handler`, `style`, `lang`
CREATED_BY_ID `integer`	Identifier of the user who created the record
MODIFIED_BY_ID `integer`	Identifier of the user who modified the record
DATE_CREATE `string`	Creation date. In the response, a string in the Bitrix24 date and time format, for example, `10.10.2024 15:55:30`
DATE_MODIFY `string`	Modification date. Same format as `DATE_CREATE`
SITE_TEMPLATE_ID `string`	Binding of the widget to a specific site template. Only for on-premise Bitrix24!

Code Examples

How to Use Examples in Documentation

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 {
          const response = await $b24.actions.v2.call.make<RepoWidgetItem[]>({
            method: 'landing.repowidget.getlist',
            params: {
              params: {
                select: ['ID', 'NAME'],
                filter: {
                  '>ID': '1',
                },
              },
            },
            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:', 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()
        
              const response = await $b24.actions.v2.call.make({
                method: 'landing.repowidget.getlist',
                params: {
                  params: {
                    select: ['ID', 'NAME'],
                    filter: {
                      '>ID': '1',
                    },
                  },
                },
                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:', 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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {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>';

Response Handling

HTTP status: 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": [
                                "vibe"
                            ],
                            "subtype": [
                                "widgetvue"
                            ],
                            "subtype_params": {
                                "rootNode": ".w-container",
                                "demoData": {
                                    "desc": "JustSome widget data",
                                    "count": "420"
                                },
                                "handler": "https://my-app.com/vibe.php",
                                "style": "https://my-app.com/vibe.css",
                                "lang": {
                                    "de": {
                                        "W_TITLE": "People and their age",
                                        "W_EMPTY": "No people"
                                    },
                                    "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+01:00",
                "date_finish": "2024-10-17T15:52:24+01:00",
                "operating": 3.899045944213867
            }
        }

Returned Data

Name
type

Description

result
array

Array of widgets. Each element of the array is an object, permissible fields are described above. If there are no matching widgets, an empty array is returned.

If the application has other blocks in the repository, the element numbering can have gaps after the widgets are selected. In that case, the array is returned in JSON as an object with numeric keys, for example, {"1": {...}, "3": {...}}. Process result as a collection of values, not as an array with consecutive indexes

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "TYPE_ERROR",
            "error_description": "Invalid type of the call argument: params"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`400`	`SYSTEM_ERROR`	—	A field that is not in the list of fields was passed in `select`, `filter`, `order`, or `group`
`400`	`TYPE_ERROR`	Invalid type of the call argument: params	The `params` parameter was not passed as an object

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Add Widget

Remove Widget

Get the list of widgets landing.repowidget.getlist

Method ParametersMethod Parameters

Parameter paramsParameter params

Fields fieldFields field

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning