Get the List of Roles landing.role.getList

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: landing

Who 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
type

Description

scope
string

The type of sites for which roles need to be retrieved. This parameter is not related to the REST scope landing in the method name.

The values GROUP, KNOWLEDGE, and MAINPAGE correspond to the types of sites described in the article Working with Site Types and Scopes.

Possible values:
GROUP - roles for group sites
KNOWLEDGE - roles for knowledge bases
MAINPAGE - roles for the main page or vibe

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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"

try
        {
            const response = await $b24.callMethod(
                'landing.role.getList',
                {
                    scope: 'KNOWLEDGE'
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.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>';
        }

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
type

Description

result
object[]

A list of roles for the selected type of sites (detailed description).

If no roles are found, the method returns result: []

time
time

Information about the execution time of the request

Role Object

Name `type`	Description
ID `string`	The identifier of the role. Use it in the methods landing.role.getRights, landing.role.setAccessCodes, and landing.role.setRights
TITLE `string`	The name of the role in the interface
XML_ID `string`	The system code of the role. Possible values for automatically created standard roles: `ADMIN` - administrator `MANAGER` - manager

Error Handling

HTTP Status: 400

{
            "error": "IS_NOT_ADMIN",
            "error_description": "To perform this action, you must be an administrator."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`ACCESS_DENIED`	No authorization or insufficient rights to work with the "Sites and Stores" module
`IS_NOT_ADMIN`	The method requires administrator rights or "full access" permission to the "Sites and Stores" section
`FEATURE_NOT_AVAIL`	Management of permissions in the "Sites and Stores" section is not available on the current plan

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Overview of Methods

Get List of Sites with Access Permissions for Role

Get the List of Roles landing.role.getList

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Role ObjectRole Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning