Get User Settings BX24.userOption.get

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.

BX24.userOption.get(string name): mixed;

The method BX24.userOption.get returns the value of the setting with the name name for the current user.

Method Parameters

Required parameters are marked with *

Name
type

Description

name*
string

Parameter code

Code Examples

BX24.init(() => {
            BX24.userOption.set('param_str', 'str');
            BX24.userOption.set('param_numb', 1);
            BX24.userOption.set('param_obj', {foo: 'bar'});
        
            console.log(BX24.userOption.get('param_str')); //will return str
            console.log(BX24.userOption.get('param_numb')); //will return 1
            console.log(BX24.userOption.get('param_obj')); //will return {foo: 'bar'}
        });

How to Use Examples in Documentation

Continue Learning

Previous
Set User Settings
Next
Set Application Settings