Get Role Rights with landing.role.getRights

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.getRights returns the rights of the specified role for each site where they are configured.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Role identifier. You can obtain the identifier using the landing.role.getList method

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 '{
            "id": 2
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.role.getRights.json"

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 2,
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.role.getRights.json"

try
        {
            const response = await $b24.callMethod(
                'landing.role.getRights',
                {
                    id: 2
                }
            );
        
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.role.getRights',
                    [
                        'id' => 2,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting role rights: ' . $e->getMessage();
        }

BX24.callMethod(
            'landing.role.getRights',
            {
                id: 2
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'landing.role.getRights',
            [
                'id' => 2,
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Error: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

Response Handling

HTTP Status: 200

{
            "result": {
                "0": [
                    "read",
                    "edit"
                ],
                "5": [
                    "read"
                ]
            },
            "time": {
                "start": 1775064046,
                "finish": 1775064046.935469,
                "duration": 0.9354689121246338,
                "processing": 0,
                "date_start": "2026-04-01T20:20:46+02:00",
                "date_finish": "2026-04-01T20:20:46+02:00",
                "operating_reset_at": 1775064646,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
array

Array of role rights by sites, where the key is the site identifier and the value is an array of rights codes (detailed description).

If the role has no saved rights or a role with such id is not found, the method returns an empty array []

time
time

Information about the execution time of the request

Result Element

Name
type

Description

0
string[]

Default role rights for all sites that do not have separate settings.

Available values are described below

<siteId>
string[]

Role rights for the site with the specified identifier.

The site identifier can be obtained using the landing.site.getList method or from the result of the landing.site.add method.

Available values are described below

Rights Codes

Code	Description
`denied`	Access to the site is denied
`read`	Read
`edit`	Modify site pages
`sett`	Change site settings
`public`	Publish
`delete`	Move to trash and restore from trash

Error Handling

HTTP Status: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Not enough call parameters, missing: id"
        }

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 access to the "Sites and Stores" section
`IS_NOT_ADMIN`	Administrator rights or "full access" permission to the "Sites and Stores" section are required for the method
`FEATURE_NOT_AVAIL`	Rights management in the "Sites and Stores" section is not available on the current plan
`MISSING_PARAMS`	Required parameter `id` is missing

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

Get List of Roles

Set Access Codes for Role

Get Role Rights with landing.role.getRights

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ElementResult Element

Rights CodesRights Codes

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning