Get the list of widgets landing.repowidget.getlist

Scope: landing

Who can execute the method: any user

The method landing.repowidget.getlist returns a list of widgets for the current application, filtered by the specified criteria.

Method Parameters

Required parameters are marked with *

Name `type`	Description
params* `object`	Array of fields to retrieve the list of widgets

Parameter params

Required parameters are marked with *

Name `type`	Description
select `array`	Array with the list of fields to be selected. If not provided or an empty array is passed, all available widgets will be selected
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. 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. The search looks for 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. The search goes from both sides. `!=%` — 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

Fields field

Fields of the widget object. Present in the request and response.

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
WIDGET_PARAMS `object`	Parameters for the Vue template engine
CONTENT `string`	Widget markup using Vue constructs
MANIFEST `object`	Widget manifest
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 `date`	Creation date
DATE_MODIFY `date`	Modification date
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

PHP

BX24.js

PHP CRest

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'landing.repowidget.getlist',
            {
              params: {
                select: [
                  'ID', 'NAME'
                ],
                filter: {
                  '>ID': '1'
                }
              }
            },
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('landing.repowidget.getlist', {
            params: {
              select: [
                'ID', 'NAME'
              ],
              filter: {
                '>ID': '1'
              }
            }
          }, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('landing.repowidget.getlist', {
            params: {
              select: [
                'ID', 'NAME'
              ],
              filter: {
                '>ID': '1'
              }
            }
          }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', 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/vibe_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/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 `object`	Array of widgets. Each element of the array is an object, permissible fields are described above.
time `time`	Information about the execution time of the request

Error Handling

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Remove Widget

Enable Debug Mode

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

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning