Получить список ролей landing.role.getList
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
landingКто может выполнять метод: администратор или пользователь с правом «полный доступ» к разделу «Сайты и магазины»
Метод landing.role.getList получает список ролей доступа для выбранного типа сайтов.
Параметры метода
|
Название |
Описание |
|
scope |
Тип сайтов, для которого нужно получить роли. Параметр не связан с REST-скоупом Значения Возможные значения: По умолчанию метод возвращает роли для сайтов и интернет-магазинов. Так будет, если параметр не передать или указать неподдерживаемое значение |
Примеры кода
Как использовать примеры в документации
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 |
Список ролей выбранного типа сайтов (подробное описание). Если роли не найдены, метод возвращает |
|
time |
Информация о времени выполнения запроса |
Объект role
|
Название |
Описание |
|
ID |
Идентификатор роли. Используйте его в методах landing.role.getRights, landing.role.setAccessCodes и landing.role.setRights |
|
TITLE |
Название роли в интерфейсе |
|
XML_ID |
Системный код роли. Возможные значения для автоматически созданных стандартных ролей: |
Обработка ошибок
HTTP-статус: 400
{
"error": "IS_NOT_ADMIN",
"error_description": "Для совершения действия необходимо быть администратором."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Нет авторизации или недостаточно прав для работы с модулем «Сайты и магазины» |
|
|
Для метода нужны права администратора или право «полный доступ» к разделу «Сайты и магазины» |
|
|
На текущем тарифе недоступно управление правами в разделе «Сайты и магазины» |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |