Get the List of Roles landing.role.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:
landingWho can execute the method: administrator or user with "full access" permission to the "Sites and Stores" section
The method landing.role.getList retrieves a list of access roles for the selected type of sites.
Method Parameters
|
Name |
Description |
|
scope |
The type of sites for which roles need to be retrieved. This parameter is not related to the REST scope The values Possible values: By default, the method returns roles for sites and online stores. This will be the case if the parameter is not provided or an unsupported value is specified |
Code Examples
How to Use Examples in Documentation
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.landing.role.get_list().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.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 'Error: ' . $result['error_description'];
}
else
{
echo '<pre>';
print_r($result['result']);
echo '</pre>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.role.getList", b24.Params{
"scope": "KNOWLEDGE",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("landing.role.getList: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
Title string `json:"TITLE"`
XMLID string `json:"XML_ID"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"ID": "3",
"TITLE": "Administrator",
"XML_ID": "ADMIN"
},
{
"ID": "5",
"TITLE": "Manager",
"XML_ID": "MANAGER"
}
],
"time": {
"start": 1775062049,
"finish": 1775062049.634052,
"duration": 0.634052038192749,
"processing": 0,
"date_start": "2026-04-01T19:47:29+01:00",
"date_finish": "2026-04-01T19:47:29+01:00",
"operating_reset_at": 1775062649,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
A list of roles for the selected type of sites (detailed description). If no roles are found, the method returns |
|
time |
Information about the execution time of the request |
Role Object
|
Name |
Description |
|
ID |
The identifier of the role. Use it in the methods landing.role.getRights, landing.role.setAccessCodes, and landing.role.setRights |
|
TITLE |
The name of the role in the interface |
|
XML_ID |
The system code of the role. Possible values for automatically created standard roles: |
Error Handling
HTTP Status: 400
{
"error": "IS_NOT_ADMIN",
"error_description": "To perform this action, you must be an administrator."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
No authorization or insufficient rights to work with the "Sites and Stores" module |
|
|
The method requires administrator rights or "full access" permission to the "Sites and Stores" section |
|
|
Management of permissions in the "Sites and Stores" section is not available on the current plan |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |