Получить список ролей landing.role.getList

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

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

Scope: landing

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

Метод landing.role.getList получает список ролей доступа для выбранного типа сайтов.

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

Название
тип

Описание

scope
string

Тип сайтов, для которого нужно получить роли. Параметр не связан с REST-скоупом landing в названии метода.

Значения GROUP, KNOWLEDGE и MAINPAGE соответствуют типам сайтов из статьи Работа с типами сайтов и скоупами.

Возможные значения:
GROUP - роли для сайтов групп
KNOWLEDGE - роли для баз знаний
MAINPAGE - роли для главной страницы или вайба

По умолчанию метод возвращает роли для сайтов и интернет-магазинов. Так будет, если параметр не передать или указать неподдерживаемое значение

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "scope": "KNOWLEDGE"
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.role.getList.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "scope": "KNOWLEDGE",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.role.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 role returned in result[]
        type RoleItem = {
          ID: string,
          TITLE: string,
          XML_ID: string,
        }
        
        try {
          // landing.role.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<RoleItem[]>({
            method: 'landing.role.getList',
            params: {
              scope: 'KNOWLEDGE',
              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('Roles:', result, 'Count:', result.length)
          }
        } 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 getRoleList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // landing.role.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.role.getList',
                params: {
                  scope: 'KNOWLEDGE',
                  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('Roles:', result, 'Count:', result.length)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getRoleList)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.role.getList',
                    [
                        'scope' => 'KNOWLEDGE',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting role list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.role.getList',
            {
                scope: 'KNOWLEDGE'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.role.getList',
            [
                'scope' => 'KNOWLEDGE',
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }
        

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

HTTP-статус: 200

{
            "result": [
                {
                    "ID": "3",
                    "TITLE": "Администратор",
                    "XML_ID": "ADMIN"
                },
                {
                    "ID": "5",
                    "TITLE": "Менеджер",
                    "XML_ID": "MANAGER"
                }
            ],
            "time": {
                "start": 1775062049,
                "finish": 1775062049.634052,
                "duration": 0.634052038192749,
                "processing": 0,
                "date_start": "2026-04-01T19:47:29+03:00",
                "date_finish": "2026-04-01T19:47:29+03:00",
                "operating_reset_at": 1775062649,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
object[]

Список ролей выбранного типа сайтов (подробное описание).

Если роли не найдены, метод возвращает result: []

time
time

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

Объект role

Название
тип

Описание

ID
string

Идентификатор роли. Используйте его в методах landing.role.getRights, landing.role.setAccessCodes и landing.role.setRights

TITLE
string

Название роли в интерфейсе

XML_ID
string

Системный код роли.

Возможные значения для автоматически созданных стандартных ролей:
ADMIN - администратор
MANAGER - менеджер

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

HTTP-статус: 400

{
            "error": "IS_NOT_ADMIN",
            "error_description": "Для совершения действия необходимо быть администратором."
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

ACCESS_DENIED

Нет авторизации или недостаточно прав для работы с модулем «Сайты и магазины»

IS_NOT_ADMIN

Для метода нужны права администратора или право «полный доступ» к разделу «Сайты и магазины»

FEATURE_NOT_AVAIL

На текущем тарифе недоступно управление правами в разделе «Сайты и магазины»

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

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

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

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